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))
113
kinds = [None] * len(files)
115
assert(len(kinds) == len(files))
117
# generic constraint checks:
118
if self.is_control_filename(f):
119
raise errors.ForbiddenControlFileError(filename=f)
121
# fill out file kinds for all files [not needed when we stop
122
# caring about the instantaneous file kind within a uncommmitted tree
124
self._gather_kinds(files, kinds)
125
self._add(files, ids, kinds)
127
def add_reference(self, sub_tree):
128
"""Add a TreeReference to the tree, pointing at sub_tree"""
129
raise errors.UnsupportedOperation(self.add_reference, self)
131
def _add_reference(self, sub_tree):
132
"""Standard add_reference implementation, for use by subclasses"""
134
sub_tree_path = self.relpath(sub_tree.basedir)
135
except errors.PathNotChild:
136
raise errors.BadReferenceTarget(self, sub_tree,
137
'Target not inside tree.')
138
sub_tree_id = sub_tree.get_root_id()
139
if sub_tree_id == self.get_root_id():
140
raise errors.BadReferenceTarget(self, sub_tree,
141
'Trees have the same root id.')
142
if sub_tree_id in self.inventory:
143
raise errors.BadReferenceTarget(self, sub_tree,
144
'Root id already present in tree')
145
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
147
def _add(self, files, ids, kinds):
148
"""Helper function for add - updates the inventory.
150
:param files: sequence of pathnames, relative to the tree root
151
:param ids: sequence of suggested ids for the files (may be None)
152
:param kinds: sequence of inventory kinds of the files (i.e. may
153
contain "tree-reference")
155
raise NotImplementedError(self._add)
157
@needs_tree_write_lock
158
def apply_inventory_delta(self, changes):
159
"""Apply changes to the inventory as an atomic operation.
161
:param changes: An inventory delta to apply to the working tree's
164
:seealso Inventory.apply_delta: For details on the changes parameter.
168
inv.apply_delta(changes)
169
self._write_inventory(inv)
172
def commit(self, message=None, revprops=None, *args,
174
# avoid circular imports
175
from bzrlib import commit
178
if not 'branch-nick' in revprops:
179
revprops['branch-nick'] = self.branch.nick
180
author = kwargs.pop('author', None)
181
if author is not None:
182
assert 'author' not in revprops
183
revprops['author'] = author
184
# args for wt.commit start at message from the Commit.commit method,
185
args = (message, ) + args
186
committed_id = commit.Commit().commit(working_tree=self,
187
revprops=revprops, *args, **kwargs)
190
def _gather_kinds(self, files, kinds):
191
"""Helper function for add - sets the entries of kinds."""
192
raise NotImplementedError(self._gather_kinds)
195
def last_revision(self):
196
"""Return the revision id of the last commit performed in this tree.
198
In early tree formats the result of last_revision is the same as the
199
branch last_revision, but that is no longer the case for modern tree
202
last_revision returns the left most parent id, or None if there are no
205
last_revision was deprecated as of 0.11. Please use get_parent_ids
208
raise NotImplementedError(self.last_revision)
210
def lock_tree_write(self):
211
"""Lock the working tree for write, and the branch for read.
213
This is useful for operations which only need to mutate the working
214
tree. Taking out branch write locks is a relatively expensive process
215
and may fail if the branch is on read only media. So branch write locks
216
should only be taken out when we are modifying branch data - such as in
217
operations like commit, pull, uncommit and update.
219
raise NotImplementedError(self.lock_tree_write)
221
def lock_write(self):
222
"""Lock the tree and its branch. This allows mutating calls to be made.
224
Some mutating methods will take out implicit write locks, but in
225
general you should always obtain a write lock before calling mutating
228
raise NotImplementedError(self.lock_write)
231
def mkdir(self, path, file_id=None):
232
"""Create a directory in the tree. if file_id is None, one is assigned.
234
:param path: A unicode file path.
235
:param file_id: An optional file-id.
236
:return: the file id of the new directory.
238
raise NotImplementedError(self.mkdir)
240
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
241
"""Set the parents ids of the working tree.
243
:param revision_ids: A list of revision_ids.
245
raise NotImplementedError(self.set_parent_ids)
247
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
248
"""Set the parents of the working tree.
250
:param parents_list: A list of (revision_id, tree) tuples.
251
If tree is None, then that element is treated as an unreachable
252
parent tree - i.e. a ghost.
254
raise NotImplementedError(self.set_parent_trees)
256
@needs_tree_write_lock
257
def smart_add(self, file_list, recurse=True, action=None, save=True):
258
"""Version file_list, optionally recursing into directories.
260
This is designed more towards DWIM for humans than API clarity.
261
For the specific behaviour see the help for cmd_add().
263
:param action: A reporter to be called with the inventory, parent_ie,
264
path and kind of the path being added. It may return a file_id if
265
a specific one should be used.
266
:param save: Save the inventory after completing the adds. If False
267
this provides dry-run functionality by doing the add and not saving
269
:return: A tuple - files_added, ignored_files. files_added is the count
270
of added files, and ignored_files is a dict mapping files that were
271
ignored to the rule that caused them to be ignored.
273
# not in an inner loop; and we want to remove direct use of this,
274
# so here as a reminder for now. RBC 20070703
275
from bzrlib.inventory import InventoryEntry
276
assert isinstance(recurse, bool)
278
action = add.AddAction()
281
# no paths supplied: add the entire tree.
283
# mutter("smart add of %r")
290
# validate user file paths and convert all paths to tree
291
# relative : it's cheaper to make a tree relative path an abspath
292
# than to convert an abspath to tree relative.
293
for filepath in file_list:
294
rf = _FastPath(self.relpath(filepath))
295
# validate user parameters. Our recursive code avoids adding new files
296
# that need such validation
297
if self.is_control_filename(rf.raw_path):
298
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
300
abspath = self.abspath(rf.raw_path)
301
kind = osutils.file_kind(abspath)
302
if kind == 'directory':
303
# schedule the dir for scanning
306
if not InventoryEntry.versionable_kind(kind):
307
raise errors.BadFileKindError(filename=abspath, kind=kind)
308
# ensure the named path is added, so that ignore rules in the later directory
310
# we dont have a parent ie known yet.: use the relatively slower inventory
312
versioned = inv.has_filename(rf.raw_path)
315
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
318
# no need to walk any directories at all.
319
if len(added) > 0 and save:
320
self._write_inventory(inv)
321
return added, ignored
323
# only walk the minimal parents needed: we have user_dirs to override
327
is_inside = osutils.is_inside_or_parent_of_any
328
for path in sorted(user_dirs):
329
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
330
dirs_to_add.append((path, None))
331
prev_dir = path.raw_path
333
# dirs_to_add is initialised to a list of directories, but as we scan
334
# directories we append files to it.
335
# XXX: We should determine kind of files when we scan them rather than
336
# adding to this list. RBC 20070703
337
for directory, parent_ie in dirs_to_add:
338
# directory is tree-relative
339
abspath = self.abspath(directory.raw_path)
341
# get the contents of this directory.
343
# find the kind of the path being added.
344
kind = osutils.file_kind(abspath)
346
if not InventoryEntry.versionable_kind(kind):
347
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
350
if parent_ie is not None:
351
versioned = directory.base_path in parent_ie.children
353
# without the parent ie, use the relatively slower inventory
355
versioned = inv.has_filename(directory.raw_path)
357
if kind == 'directory':
359
sub_branch = bzrdir.BzrDir.open(abspath)
361
except errors.NotBranchError:
363
except errors.UnsupportedFormatError:
368
if directory.raw_path == '':
369
# mutter("tree root doesn't need to be added")
373
# mutter("%r is already versioned", abspath)
375
# XXX: This is wrong; people *might* reasonably be trying to add
376
# subtrees as subtrees. This should probably only be done in formats
377
# which can represent subtrees, and even then perhaps only when
378
# the user asked to add subtrees. At the moment you can add them
379
# specially through 'join --reference', which is perhaps
380
# reasonable: adding a new reference is a special operation and
381
# can have a special behaviour. mbp 20070306
382
mutter("%r is a nested bzr tree", abspath)
384
_add_one(self, inv, parent_ie, directory, kind, action)
385
added.append(directory.raw_path)
387
if kind == 'directory' and not sub_tree:
388
if parent_ie is not None:
390
this_ie = parent_ie.children[directory.base_path]
392
# without the parent ie, use the relatively slower inventory
394
this_id = inv.path2id(directory.raw_path)
398
this_ie = inv[this_id]
400
for subf in sorted(os.listdir(abspath)):
401
# here we could use TreeDirectory rather than
402
# string concatenation.
403
subp = osutils.pathjoin(directory.raw_path, subf)
404
# TODO: is_control_filename is very slow. Make it faster.
405
# TreeDirectory.is_control_filename could also make this
406
# faster - its impossible for a non root dir to have a
408
if self.is_control_filename(subp):
409
mutter("skip control directory %r", subp)
410
elif subf in this_ie.children:
411
# recurse into this already versioned subdir.
412
dirs_to_add.append((_FastPath(subp, subf), this_ie))
414
# user selection overrides ignoes
415
# ignore while selecting files - if we globbed in the
416
# outer loop we would ignore user files.
417
ignore_glob = self.is_ignored(subp)
418
if ignore_glob is not None:
419
# mutter("skip ignored sub-file %r", subp)
420
ignored.setdefault(ignore_glob, []).append(subp)
422
#mutter("queue to add sub-file %r", subp)
423
dirs_to_add.append((_FastPath(subp, subf), this_ie))
427
self._write_inventory(inv)
429
self.read_working_inventory()
430
return added, ignored
432
def update_basis_by_delta(self, new_revid, delta):
433
"""Update the parents of this tree after a commit.
435
This gives the tree one parent, with revision id new_revid. The
436
inventory delta is applied to the current basis tree to generate the
437
inventory for the parent new_revid, and all other parent trees are
440
All the changes in the delta should be changes synchronising the basis
441
tree with some or all of the working tree, with a change to a directory
442
requiring that its contents have been recursively included. That is,
443
this is not a general purpose tree modification routine, but a helper
444
for commit which is not required to handle situations that do not arise
447
:param new_revid: The new revision id for the trees parent.
448
:param delta: An inventory delta (see apply_inventory_delta) describing
449
the changes from the current left most parent revision to new_revid.
451
# if the tree is updated by a pull to the branch, as happens in
452
# WorkingTree2, when there was no separation between branch and tree,
453
# then just clear merges, efficiency is not a concern for now as this
454
# is legacy environments only, and they are slow regardless.
455
if self.last_revision() == new_revid:
456
self.set_parent_ids([new_revid])
458
# generic implementation based on Inventory manipulation. See
459
# WorkingTree classes for optimised versions for specific format trees.
460
basis = self.basis_tree()
462
inventory = basis.inventory
464
inventory.apply_delta(delta)
465
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
466
self.set_parent_trees([(new_revid, rev_tree)])
469
class _FastPath(object):
470
"""A path object with fast accessors for things like basename."""
472
__slots__ = ['raw_path', 'base_path']
474
def __init__(self, path, base_path=None):
475
"""Construct a FastPath from path."""
476
if base_path is None:
477
self.base_path = osutils.basename(path)
479
self.base_path = base_path
482
def __cmp__(self, other):
483
return cmp(self.raw_path, other.raw_path)
486
return hash(self.raw_path)
489
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
490
"""Add a new entry to the inventory and automatically add unversioned parents.
492
:param inv: Inventory which will receive the new entry.
493
:param parent_ie: Parent inventory entry if known, or None. If
494
None, the parent is looked up by name and used if present, otherwise it
495
is recursively added.
496
:param kind: Kind of new entry (file, directory, etc)
497
:param action: callback(inv, parent_ie, path, kind); return ignored.
498
:return: A list of paths which have been added.
500
# Nothing to do if path is already versioned.
501
# This is safe from infinite recursion because the tree root is
503
if parent_ie is not None:
504
# we have a parent ie already
507
# slower but does not need parent_ie
508
if inv.has_filename(path.raw_path):
510
# its really not there : add the parent
511
# note that the dirname use leads to some extra str copying etc but as
512
# there are a limited number of dirs we can be nested under, it should
513
# generally find it very fast and not recurse after that.
514
added = _add_one_and_parent(tree, inv, None,
515
_FastPath(dirname(path.raw_path)), 'directory', action)
516
parent_id = inv.path2id(dirname(path.raw_path))
517
parent_ie = inv[parent_id]
518
_add_one(tree, inv, parent_ie, path, kind, action)
519
return added + [path.raw_path]
522
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
523
"""Add a new entry to the inventory.
525
:param inv: Inventory which will receive the new entry.
526
:param parent_ie: Parent inventory entry.
527
:param kind: Kind of new entry (file, directory, etc)
528
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
529
file_id or None to generate a new file id
532
file_id = file_id_callback(inv, parent_ie, path, kind)
533
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
