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.trace import mutter, warning
40
from bzrlib.decorators import needs_read_lock, needs_write_lock
41
from bzrlib.osutils import splitpath
42
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
45
def needs_tree_write_lock(unbound):
46
"""Decorate unbound to take out and release a tree_write lock."""
47
def tree_write_locked(self, *args, **kwargs):
48
self.lock_tree_write()
50
return unbound(self, *args, **kwargs)
53
tree_write_locked.__doc__ = unbound.__doc__
54
tree_write_locked.__name__ = unbound.__name__
55
return tree_write_locked
58
class MutableTree(tree.Tree):
59
"""A MutableTree is a specialisation of Tree which is able to be mutated.
61
Generally speaking these mutations are only possible within a lock_write
62
context, and will revert if the lock is broken abnormally - but this cannot
63
be guaranteed - depending on the exact implementation of the mutable state.
65
The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
66
For tests we also have MemoryTree which is a MutableTree whose contents are
69
For now, we are not treating MutableTree as an interface to provide
70
conformance tests for - rather we are testing MemoryTree specifically, and
71
interface testing implementations of WorkingTree.
73
A mutable tree always has an associated Branch and BzrDir object - the
74
branch and bzrdir attributes.
77
@needs_tree_write_lock
78
def add(self, files, ids=None, kinds=None):
79
"""Add paths to the set of versioned paths.
81
Note that the command line normally calls smart_add instead,
82
which can automatically recurse.
84
This adds the files to the inventory, so that they will be
85
recorded by the next commit.
87
:param files: List of paths to add, relative to the base of the tree.
88
:param ids: If set, use these instead of automatically generated ids.
89
Must be the same length as the list of files, but may
90
contain None for ids that are to be autogenerated.
91
:param kinds: Optional parameter to specify the kinds to be used for
94
TODO: Perhaps callback with the ids and paths as they're added.
96
if isinstance(files, basestring):
97
assert(ids is None or isinstance(ids, basestring))
98
assert(kinds is None or isinstance(kinds, basestring))
102
if kinds is not None:
105
files = [path.strip('/') for path in files]
108
ids = [None] * len(files)
110
assert(len(ids) == len(files))
111
ids = [osutils.safe_file_id(file_id) for file_id in ids]
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
The argument is a set of changes to apply. It must describe a
163
valid result, but the order is not important. Specifically,
164
intermediate stages *may* be invalid, such as when two files
167
The changes should be structured as a list of tuples, of the form
168
(old_path, new_path, file_id, new_entry). For creation, old_path
169
must be None. For deletion, new_path and new_entry must be None.
170
file_id is always non-None. For renames and other mutations, all
171
values must be non-None.
173
If the new_entry is a directory, its children should be an empty
174
dict. Children are handled by apply_inventory_delta itself.
176
:param changes: A list of tuples for the change to apply:
177
[(old_path, new_path, file_id, new_inventory_entry), ...]
182
for old_path, file_id in sorted(((op, f) for op, np, f, e in changes
183
if op is not None), reverse=True):
184
if file_id not in inv:
186
children[file_id] = getattr(inv[file_id], 'children', {})
187
inv.remove_recursive_id(file_id)
188
for new_path, new_entry in sorted((np, e) for op, np, f, e in
189
changes if np is not None):
190
if getattr(new_entry, 'children', None) is not None:
191
new_entry.children = children.get(new_entry.file_id, {})
193
self._write_inventory(inv)
196
def commit(self, message=None, revprops=None, *args,
198
# avoid circular imports
199
from bzrlib import commit
202
if not 'branch-nick' in revprops:
203
revprops['branch-nick'] = self.branch.nick
204
author = kwargs.pop('author', None)
205
if not 'author' in revprops and author:
206
revprops['author'] = author
207
# args for wt.commit start at message from the Commit.commit method,
208
args = (message, ) + args
209
committed_id = commit.Commit().commit(working_tree=self,
210
revprops=revprops, *args, **kwargs)
213
def _gather_kinds(self, files, kinds):
214
"""Helper function for add - sets the entries of kinds."""
215
raise NotImplementedError(self._gather_kinds)
218
def last_revision(self):
219
"""Return the revision id of the last commit performed in this tree.
221
In early tree formats the result of last_revision is the same as the
222
branch last_revision, but that is no longer the case for modern tree
225
last_revision returns the left most parent id, or None if there are no
228
last_revision was deprecated as of 0.11. Please use get_parent_ids
231
raise NotImplementedError(self.last_revision)
233
def lock_tree_write(self):
234
"""Lock the working tree for write, and the branch for read.
236
This is useful for operations which only need to mutate the working
237
tree. Taking out branch write locks is a relatively expensive process
238
and may fail if the branch is on read only media. So branch write locks
239
should only be taken out when we are modifying branch data - such as in
240
operations like commit, pull, uncommit and update.
242
raise NotImplementedError(self.lock_tree_write)
244
def lock_write(self):
245
"""Lock the tree and its branch. This allows mutating calls to be made.
247
Some mutating methods will take out implicit write locks, but in
248
general you should always obtain a write lock before calling mutating
251
raise NotImplementedError(self.lock_write)
254
def mkdir(self, path, file_id=None):
255
"""Create a directory in the tree. if file_id is None, one is assigned.
257
:param path: A unicode file path.
258
:param file_id: An optional file-id.
259
:return: the file id of the new directory.
261
raise NotImplementedError(self.mkdir)
263
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
264
"""Set the parents ids of the working tree.
266
:param revision_ids: A list of revision_ids.
268
raise NotImplementedError(self.set_parent_ids)
270
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
271
"""Set the parents of the working tree.
273
:param parents_list: A list of (revision_id, tree) tuples.
274
If tree is None, then that element is treated as an unreachable
275
parent tree - i.e. a ghost.
277
raise NotImplementedError(self.set_parent_trees)
279
@needs_tree_write_lock
280
def smart_add(self, file_list, recurse=True, action=None, save=True):
281
"""Version file_list, optionally recursing into directories.
283
This is designed more towards DWIM for humans than API clarity.
284
For the specific behaviour see the help for cmd_add().
286
:param action: A reporter to be called with the inventory, parent_ie,
287
path and kind of the path being added. It may return a file_id if
288
a specific one should be used.
289
:param save: Save the inventory after completing the adds. If False
290
this provides dry-run functionality by doing the add and not saving
292
:return: A tuple - files_added, ignored_files. files_added is the count
293
of added files, and ignored_files is a dict mapping files that were
294
ignored to the rule that caused them to be ignored.
296
# not in an inner loop; and we want to remove direct use of this,
297
# so here as a reminder for now. RBC 20070703
298
from bzrlib.inventory import InventoryEntry
299
assert isinstance(recurse, bool)
301
action = add.AddAction()
304
# no paths supplied: add the entire tree.
306
# mutter("smart add of %r")
313
# validate user file paths and convert all paths to tree
314
# relative : it's cheaper to make a tree relative path an abspath
315
# than to convert an abspath to tree relative.
316
for filepath in file_list:
317
rf = _FastPath(self.relpath(filepath))
318
# validate user parameters. Our recursive code avoids adding new files
319
# that need such validation
320
if self.is_control_filename(rf.raw_path):
321
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
323
abspath = self.abspath(rf.raw_path)
324
kind = osutils.file_kind(abspath)
325
if kind == 'directory':
326
# schedule the dir for scanning
329
if not InventoryEntry.versionable_kind(kind):
330
raise errors.BadFileKindError(filename=abspath, kind=kind)
331
# ensure the named path is added, so that ignore rules in the later directory
333
# we dont have a parent ie known yet.: use the relatively slower inventory
335
versioned = inv.has_filename(rf.raw_path)
338
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
341
# no need to walk any directories at all.
342
if len(added) > 0 and save:
343
self._write_inventory(inv)
344
return added, ignored
346
# only walk the minimal parents needed: we have user_dirs to override
350
is_inside = osutils.is_inside_or_parent_of_any
351
for path in sorted(user_dirs):
352
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
353
dirs_to_add.append((path, None))
354
prev_dir = path.raw_path
356
# dirs_to_add is initialised to a list of directories, but as we scan
357
# directories we append files to it.
358
# XXX: We should determine kind of files when we scan them rather than
359
# adding to this list. RBC 20070703
360
for directory, parent_ie in dirs_to_add:
361
# directory is tree-relative
362
abspath = self.abspath(directory.raw_path)
364
# get the contents of this directory.
366
# find the kind of the path being added.
367
kind = osutils.file_kind(abspath)
369
if not InventoryEntry.versionable_kind(kind):
370
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
373
if parent_ie is not None:
374
versioned = directory.base_path in parent_ie.children
376
# without the parent ie, use the relatively slower inventory
378
versioned = inv.has_filename(directory.raw_path)
380
if kind == 'directory':
382
sub_branch = bzrdir.BzrDir.open(abspath)
384
except errors.NotBranchError:
386
except errors.UnsupportedFormatError:
391
if directory.raw_path == '':
392
# mutter("tree root doesn't need to be added")
396
# mutter("%r is already versioned", abspath)
398
# XXX: This is wrong; people *might* reasonably be trying to add
399
# subtrees as subtrees. This should probably only be done in formats
400
# which can represent subtrees, and even then perhaps only when
401
# the user asked to add subtrees. At the moment you can add them
402
# specially through 'join --reference', which is perhaps
403
# reasonable: adding a new reference is a special operation and
404
# can have a special behaviour. mbp 20070306
405
mutter("%r is a nested bzr tree", abspath)
407
_add_one(self, inv, parent_ie, directory, kind, action)
408
added.append(directory.raw_path)
410
if kind == 'directory' and not sub_tree:
411
if parent_ie is not None:
413
this_ie = parent_ie.children[directory.base_path]
415
# without the parent ie, use the relatively slower inventory
417
this_id = inv.path2id(directory.raw_path)
421
this_ie = inv[this_id]
423
for subf in sorted(os.listdir(abspath)):
424
# here we could use TreeDirectory rather than
425
# string concatenation.
426
subp = osutils.pathjoin(directory.raw_path, subf)
427
# TODO: is_control_filename is very slow. Make it faster.
428
# TreeDirectory.is_control_filename could also make this
429
# faster - its impossible for a non root dir to have a
431
if self.is_control_filename(subp):
432
mutter("skip control directory %r", subp)
433
elif subf in this_ie.children:
434
# recurse into this already versioned subdir.
435
dirs_to_add.append((_FastPath(subp, subf), this_ie))
437
# user selection overrides ignoes
438
# ignore while selecting files - if we globbed in the
439
# outer loop we would ignore user files.
440
ignore_glob = self.is_ignored(subp)
441
if ignore_glob is not None:
442
# mutter("skip ignored sub-file %r", subp)
443
ignored.setdefault(ignore_glob, []).append(subp)
445
#mutter("queue to add sub-file %r", subp)
446
dirs_to_add.append((_FastPath(subp, subf), this_ie))
450
self._write_inventory(inv)
452
self.read_working_inventory()
453
return added, ignored
456
class _FastPath(object):
457
"""A path object with fast accessors for things like basename."""
459
__slots__ = ['raw_path', 'base_path']
461
def __init__(self, path, base_path=None):
462
"""Construct a FastPath from path."""
463
if base_path is None:
464
self.base_path = osutils.basename(path)
466
self.base_path = base_path
469
def __cmp__(self, other):
470
return cmp(self.raw_path, other.raw_path)
473
return hash(self.raw_path)
476
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
477
"""Add a new entry to the inventory and automatically add unversioned parents.
479
:param inv: Inventory which will receive the new entry.
480
:param parent_ie: Parent inventory entry if known, or None. If
481
None, the parent is looked up by name and used if present, otherwise it
482
is recursively added.
483
:param kind: Kind of new entry (file, directory, etc)
484
:param action: callback(inv, parent_ie, path, kind); return ignored.
485
:return: A list of paths which have been added.
487
# Nothing to do if path is already versioned.
488
# This is safe from infinite recursion because the tree root is
490
if parent_ie is not None:
491
# we have a parent ie already
494
# slower but does not need parent_ie
495
if inv.has_filename(path.raw_path):
497
# its really not there : add the parent
498
# note that the dirname use leads to some extra str copying etc but as
499
# there are a limited number of dirs we can be nested under, it should
500
# generally find it very fast and not recurse after that.
501
added = _add_one_and_parent(tree, inv, None,
502
_FastPath(dirname(path.raw_path)), 'directory', action)
503
parent_id = inv.path2id(dirname(path.raw_path))
504
parent_ie = inv[parent_id]
505
_add_one(tree, inv, parent_ie, path, kind, action)
506
return added + [path.raw_path]
509
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
510
"""Add a new entry to the inventory.
512
:param inv: Inventory which will receive the new entry.
513
:param parent_ie: Parent inventory entry.
514
:param kind: Kind of new entry (file, directory, etc)
515
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
516
file_id or None to generate a new file id
519
file_id = file_id_callback(inv, parent_ie, path, kind)
520
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
