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(), """
31
from bzrlib.osutils import dirname
32
from bzrlib.revisiontree import RevisionTree
33
from bzrlib.trace import mutter, warning
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
42
from bzrlib.osutils import splitpath
43
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
46
def needs_tree_write_lock(unbound):
47
"""Decorate unbound to take out and release a tree_write lock."""
48
def tree_write_locked(self, *args, **kwargs):
49
self.lock_tree_write()
51
return unbound(self, *args, **kwargs)
54
tree_write_locked.__doc__ = unbound.__doc__
55
tree_write_locked.__name__ = unbound.__name__
56
return tree_write_locked
59
class MutableTree(tree.Tree):
60
"""A MutableTree is a specialisation of Tree which is able to be mutated.
62
Generally speaking these mutations are only possible within a lock_write
63
context, and will revert if the lock is broken abnormally - but this cannot
64
be guaranteed - depending on the exact implementation of the mutable state.
66
The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
67
For tests we also have MemoryTree which is a MutableTree whose contents are
70
For now, we are not treating MutableTree as an interface to provide
71
conformance tests for - rather we are testing MemoryTree specifically, and
72
interface testing implementations of WorkingTree.
74
A mutable tree always has an associated Branch and BzrDir object - the
75
branch and bzrdir attributes.
78
@needs_tree_write_lock
79
def add(self, files, ids=None, kinds=None):
80
"""Add paths to the set of versioned paths.
82
Note that the command line normally calls smart_add instead,
83
which can automatically recurse.
85
This adds the files to the inventory, so that they will be
86
recorded by the next commit.
88
:param files: List of paths to add, relative to the base of the tree.
89
:param ids: If set, use these instead of automatically generated ids.
90
Must be the same length as the list of files, but may
91
contain None for ids that are to be autogenerated.
92
:param kinds: Optional parameter to specify the kinds to be used for
95
TODO: Perhaps callback with the ids and paths as they're added.
97
if isinstance(files, basestring):
98
assert(ids is None or isinstance(ids, basestring))
99
assert(kinds is None or isinstance(kinds, basestring))
103
if kinds is not None:
106
files = [path.strip('/') for path in files]
109
ids = [None] * len(files)
111
assert(len(ids) == len(files))
112
ids = [osutils.safe_file_id(file_id) for file_id in ids]
115
kinds = [None] * len(files)
117
assert(len(kinds) == len(files))
119
# generic constraint checks:
120
if self.is_control_filename(f):
121
raise errors.ForbiddenControlFileError(filename=f)
123
# fill out file kinds for all files [not needed when we stop
124
# caring about the instantaneous file kind within a uncommmitted tree
126
self._gather_kinds(files, kinds)
127
self._add(files, ids, kinds)
129
def add_reference(self, sub_tree):
130
"""Add a TreeReference to the tree, pointing at sub_tree"""
131
raise errors.UnsupportedOperation(self.add_reference, self)
133
def _add_reference(self, sub_tree):
134
"""Standard add_reference implementation, for use by subclasses"""
136
sub_tree_path = self.relpath(sub_tree.basedir)
137
except errors.PathNotChild:
138
raise errors.BadReferenceTarget(self, sub_tree,
139
'Target not inside tree.')
140
sub_tree_id = sub_tree.get_root_id()
141
if sub_tree_id == self.get_root_id():
142
raise errors.BadReferenceTarget(self, sub_tree,
143
'Trees have the same root id.')
144
if sub_tree_id in self.inventory:
145
raise errors.BadReferenceTarget(self, sub_tree,
146
'Root id already present in tree')
147
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
149
def _add(self, files, ids, kinds):
150
"""Helper function for add - updates the inventory.
152
:param files: sequence of pathnames, relative to the tree root
153
:param ids: sequence of suggested ids for the files (may be None)
154
:param kinds: sequence of inventory kinds of the files (i.e. may
155
contain "tree-reference")
157
raise NotImplementedError(self._add)
159
@needs_tree_write_lock
160
def apply_inventory_delta(self, changes):
161
"""Apply changes to the inventory as an atomic operation.
163
:param changes: An inventory delta to apply to the working tree's
166
:seealso Inventory.apply_delta: For details on the changes parameter.
170
inv.apply_delta(changes)
171
self._write_inventory(inv)
174
def commit(self, message=None, revprops=None, *args,
176
# avoid circular imports
177
from bzrlib import commit
180
if not 'branch-nick' in revprops:
181
revprops['branch-nick'] = self.branch.nick
182
author = kwargs.pop('author', None)
183
if author is not None:
184
assert 'author' not in revprops
185
revprops['author'] = author
186
# args for wt.commit start at message from the Commit.commit method,
187
args = (message, ) + args
188
committed_id = commit.Commit().commit(working_tree=self,
189
revprops=revprops, *args, **kwargs)
192
def _gather_kinds(self, files, kinds):
193
"""Helper function for add - sets the entries of kinds."""
194
raise NotImplementedError(self._gather_kinds)
197
def last_revision(self):
198
"""Return the revision id of the last commit performed in this tree.
200
In early tree formats the result of last_revision is the same as the
201
branch last_revision, but that is no longer the case for modern tree
204
last_revision returns the left most parent id, or None if there are no
207
last_revision was deprecated as of 0.11. Please use get_parent_ids
210
raise NotImplementedError(self.last_revision)
212
def lock_tree_write(self):
213
"""Lock the working tree for write, and the branch for read.
215
This is useful for operations which only need to mutate the working
216
tree. Taking out branch write locks is a relatively expensive process
217
and may fail if the branch is on read only media. So branch write locks
218
should only be taken out when we are modifying branch data - such as in
219
operations like commit, pull, uncommit and update.
221
raise NotImplementedError(self.lock_tree_write)
223
def lock_write(self):
224
"""Lock the tree and its branch. This allows mutating calls to be made.
226
Some mutating methods will take out implicit write locks, but in
227
general you should always obtain a write lock before calling mutating
230
raise NotImplementedError(self.lock_write)
233
def mkdir(self, path, file_id=None):
234
"""Create a directory in the tree. if file_id is None, one is assigned.
236
:param path: A unicode file path.
237
:param file_id: An optional file-id.
238
:return: the file id of the new directory.
240
raise NotImplementedError(self.mkdir)
242
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
243
"""Set the parents ids of the working tree.
245
:param revision_ids: A list of revision_ids.
247
raise NotImplementedError(self.set_parent_ids)
249
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
250
"""Set the parents of the working tree.
252
:param parents_list: A list of (revision_id, tree) tuples.
253
If tree is None, then that element is treated as an unreachable
254
parent tree - i.e. a ghost.
256
raise NotImplementedError(self.set_parent_trees)
258
@needs_tree_write_lock
259
def smart_add(self, file_list, recurse=True, action=None, save=True):
260
"""Version file_list, optionally recursing into directories.
262
This is designed more towards DWIM for humans than API clarity.
263
For the specific behaviour see the help for cmd_add().
265
:param action: A reporter to be called with the inventory, parent_ie,
266
path and kind of the path being added. It may return a file_id if
267
a specific one should be used.
268
:param save: Save the inventory after completing the adds. If False
269
this provides dry-run functionality by doing the add and not saving
271
:return: A tuple - files_added, ignored_files. files_added is the count
272
of added files, and ignored_files is a dict mapping files that were
273
ignored to the rule that caused them to be ignored.
275
# not in an inner loop; and we want to remove direct use of this,
276
# so here as a reminder for now. RBC 20070703
277
from bzrlib.inventory import InventoryEntry
278
assert isinstance(recurse, bool)
280
action = add.AddAction()
283
# no paths supplied: add the entire tree.
285
# mutter("smart add of %r")
292
# validate user file paths and convert all paths to tree
293
# relative : it's cheaper to make a tree relative path an abspath
294
# than to convert an abspath to tree relative.
295
for filepath in file_list:
296
rf = _FastPath(self.relpath(filepath))
297
# validate user parameters. Our recursive code avoids adding new files
298
# that need such validation
299
if self.is_control_filename(rf.raw_path):
300
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
302
abspath = self.abspath(rf.raw_path)
303
kind = osutils.file_kind(abspath)
304
if kind == 'directory':
305
# schedule the dir for scanning
308
if not InventoryEntry.versionable_kind(kind):
309
raise errors.BadFileKindError(filename=abspath, kind=kind)
310
# ensure the named path is added, so that ignore rules in the later directory
312
# we dont have a parent ie known yet.: use the relatively slower inventory
314
versioned = inv.has_filename(rf.raw_path)
317
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
320
# no need to walk any directories at all.
321
if len(added) > 0 and save:
322
self._write_inventory(inv)
323
return added, ignored
325
# only walk the minimal parents needed: we have user_dirs to override
329
is_inside = osutils.is_inside_or_parent_of_any
330
for path in sorted(user_dirs):
331
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
332
dirs_to_add.append((path, None))
333
prev_dir = path.raw_path
335
# dirs_to_add is initialised to a list of directories, but as we scan
336
# directories we append files to it.
337
# XXX: We should determine kind of files when we scan them rather than
338
# adding to this list. RBC 20070703
339
for directory, parent_ie in dirs_to_add:
340
# directory is tree-relative
341
abspath = self.abspath(directory.raw_path)
343
# get the contents of this directory.
345
# find the kind of the path being added.
346
kind = osutils.file_kind(abspath)
348
if not InventoryEntry.versionable_kind(kind):
349
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
352
if parent_ie is not None:
353
versioned = directory.base_path in parent_ie.children
355
# without the parent ie, use the relatively slower inventory
357
versioned = inv.has_filename(directory.raw_path)
359
if kind == 'directory':
361
sub_branch = bzrdir.BzrDir.open(abspath)
363
except errors.NotBranchError:
365
except errors.UnsupportedFormatError:
370
if directory.raw_path == '':
371
# mutter("tree root doesn't need to be added")
375
# mutter("%r is already versioned", abspath)
377
# XXX: This is wrong; people *might* reasonably be trying to add
378
# subtrees as subtrees. This should probably only be done in formats
379
# which can represent subtrees, and even then perhaps only when
380
# the user asked to add subtrees. At the moment you can add them
381
# specially through 'join --reference', which is perhaps
382
# reasonable: adding a new reference is a special operation and
383
# can have a special behaviour. mbp 20070306
384
mutter("%r is a nested bzr tree", abspath)
386
_add_one(self, inv, parent_ie, directory, kind, action)
387
added.append(directory.raw_path)
389
if kind == 'directory' and not sub_tree:
390
if parent_ie is not None:
392
this_ie = parent_ie.children[directory.base_path]
394
# without the parent ie, use the relatively slower inventory
396
this_id = inv.path2id(directory.raw_path)
400
this_ie = inv[this_id]
402
for subf in sorted(os.listdir(abspath)):
403
# here we could use TreeDirectory rather than
404
# string concatenation.
405
subp = osutils.pathjoin(directory.raw_path, subf)
406
# TODO: is_control_filename is very slow. Make it faster.
407
# TreeDirectory.is_control_filename could also make this
408
# faster - its impossible for a non root dir to have a
410
if self.is_control_filename(subp):
411
mutter("skip control directory %r", subp)
412
elif subf in this_ie.children:
413
# recurse into this already versioned subdir.
414
dirs_to_add.append((_FastPath(subp, subf), this_ie))
416
# user selection overrides ignoes
417
# ignore while selecting files - if we globbed in the
418
# outer loop we would ignore user files.
419
ignore_glob = self.is_ignored(subp)
420
if ignore_glob is not None:
421
# mutter("skip ignored sub-file %r", subp)
422
ignored.setdefault(ignore_glob, []).append(subp)
424
#mutter("queue to add sub-file %r", subp)
425
dirs_to_add.append((_FastPath(subp, subf), this_ie))
429
self._write_inventory(inv)
431
self.read_working_inventory()
432
return added, ignored
434
def update_to_one_parent_via_delta(self, new_revid, delta):
435
"""Update the parents of this tree after a commit.
437
This gives the tree one parent, with revision id new_revid. The
438
inventory delta is applied ot the current basis tree to generate the
439
inventory for the parent new_revid, and all other parent trees are
442
:param new_revid: The new revision id for the trees parent.
443
:param delta: An inventory delta (see apply_inventory_delta) describing
444
the changes from the current left most parent revision to new_revid.
446
# if the tree is updated by a pull to the branch, as happens in
447
# WorkingTree2, when there was no separation between branch and tree,
448
# then just clear merges, efficiency is not a concern for now as this
449
# is legacy environments only, and they are slow regardless.
450
if self.last_revision() == new_revid:
451
self.set_parent_ids([new_revid])
453
# generic implementation based on Inventory manipulation. See
454
# WorkingTree classes for optimised versions for specific format trees.
455
basis = self.basis_tree()
457
inventory = basis.inventory
459
inventory.apply_delta(delta)
460
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
461
self.set_parent_trees([(new_revid, rev_tree)])
464
class _FastPath(object):
465
"""A path object with fast accessors for things like basename."""
467
__slots__ = ['raw_path', 'base_path']
469
def __init__(self, path, base_path=None):
470
"""Construct a FastPath from path."""
471
if base_path is None:
472
self.base_path = osutils.basename(path)
474
self.base_path = base_path
477
def __cmp__(self, other):
478
return cmp(self.raw_path, other.raw_path)
481
return hash(self.raw_path)
484
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
485
"""Add a new entry to the inventory and automatically add unversioned parents.
487
:param inv: Inventory which will receive the new entry.
488
:param parent_ie: Parent inventory entry if known, or None. If
489
None, the parent is looked up by name and used if present, otherwise it
490
is recursively added.
491
:param kind: Kind of new entry (file, directory, etc)
492
:param action: callback(inv, parent_ie, path, kind); return ignored.
493
:return: A list of paths which have been added.
495
# Nothing to do if path is already versioned.
496
# This is safe from infinite recursion because the tree root is
498
if parent_ie is not None:
499
# we have a parent ie already
502
# slower but does not need parent_ie
503
if inv.has_filename(path.raw_path):
505
# its really not there : add the parent
506
# note that the dirname use leads to some extra str copying etc but as
507
# there are a limited number of dirs we can be nested under, it should
508
# generally find it very fast and not recurse after that.
509
added = _add_one_and_parent(tree, inv, None,
510
_FastPath(dirname(path.raw_path)), 'directory', action)
511
parent_id = inv.path2id(dirname(path.raw_path))
512
parent_ie = inv[parent_id]
513
_add_one(tree, inv, parent_ie, path, kind, action)
514
return added + [path.raw_path]
517
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
518
"""Add a new entry to the inventory.
520
:param inv: Inventory which will receive the new entry.
521
:param parent_ie: Parent inventory entry.
522
:param kind: Kind of new entry (file, directory, etc)
523
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
524
file_id or None to generate a new file id
527
file_id = file_id_callback(inv, parent_ie, path, kind)
528
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
