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(), """
27
from bzrlib import add
28
from bzrlib import bzrdir
29
from bzrlib.osutils import dirname
30
from bzrlib.trace import mutter
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
from bzrlib.osutils import splitpath
40
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
43
def needs_tree_write_lock(unbound):
44
"""Decorate unbound to take out and release a tree_write lock."""
45
def tree_write_locked(self, *args, **kwargs):
46
self.lock_tree_write()
48
return unbound(self, *args, **kwargs)
51
tree_write_locked.__doc__ = unbound.__doc__
52
tree_write_locked.__name__ = unbound.__name__
53
return tree_write_locked
56
class MutableTree(tree.Tree):
57
"""A MutableTree is a specialisation of Tree which is able to be mutated.
59
Generally speaking these mutations are only possible within a lock_write
60
context, and will revert if the lock is broken abnormally - but this cannot
61
be guaranteed - depending on the exact implementation of the mutable state.
63
The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
64
For tests we also have MemoryTree which is a MutableTree whose contents are
67
For now, we are not treating MutableTree as an interface to provide
68
conformance tests for - rather we are testing MemoryTree specifically, and
69
interface testing implementations of WorkingTree.
71
A mutable tree always has an associated Branch and BzrDir object - the
72
branch and bzrdir attributes.
75
@needs_tree_write_lock
76
def add(self, files, ids=None, kinds=None):
77
"""Add paths to the set of versioned paths.
79
Note that the command line normally calls smart_add instead,
80
which can automatically recurse.
82
This adds the files to the inventory, so that they will be
83
recorded by the next commit.
85
:param files: List of paths to add, relative to the base of the tree.
86
:param ids: If set, use these instead of automatically generated ids.
87
Must be the same length as the list of files, but may
88
contain None for ids that are to be autogenerated.
89
:param kinds: Optional parameter to specify the kinds to be used for
92
TODO: Perhaps callback with the ids and paths as they're added.
94
if isinstance(files, basestring):
95
assert(ids is None or isinstance(ids, basestring))
96
assert(kinds is None or isinstance(kinds, basestring))
100
if kinds is not None:
103
files = [path.strip('/') for path in files]
106
ids = [None] * len(files)
108
assert(len(ids) == len(files))
109
ids = [osutils.safe_file_id(file_id) for file_id in ids]
112
kinds = [None] * len(files)
114
assert(len(kinds) == len(files))
116
# generic constraint checks:
117
if self.is_control_filename(f):
118
raise errors.ForbiddenControlFileError(filename=f)
120
# fill out file kinds for all files [not needed when we stop
121
# caring about the instantaneous file kind within a uncommmitted tree
123
self._gather_kinds(files, kinds)
124
self._add(files, ids, kinds)
126
def add_reference(self, sub_tree):
127
"""Add a TreeReference to the tree, pointing at sub_tree"""
128
raise errors.UnsupportedOperation(self.add_reference, self)
130
def _add_reference(self, sub_tree):
131
"""Standard add_reference implementation, for use by subclasses"""
133
sub_tree_path = self.relpath(sub_tree.basedir)
134
except errors.PathNotChild:
135
raise errors.BadReferenceTarget(self, sub_tree,
136
'Target not inside tree.')
137
sub_tree_id = sub_tree.get_root_id()
138
if sub_tree_id == self.get_root_id():
139
raise errors.BadReferenceTarget(self, sub_tree,
140
'Trees have the same root id.')
141
if sub_tree_id in self.inventory:
142
raise errors.BadReferenceTarget(self, sub_tree,
143
'Root id already present in tree')
144
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
146
def _add(self, files, ids, kinds):
147
"""Helper function for add - updates the inventory.
149
:param files: sequence of pathnames, relative to the tree root
150
:param ids: sequence of suggested ids for the files (may be None)
151
:param kinds: sequence of inventory kinds of the files (i.e. may
152
contain "tree-reference")
154
raise NotImplementedError(self._add)
156
@needs_tree_write_lock
157
def apply_inventory_delta(self, changes):
158
"""Apply changes to the inventory as an atomic operation.
160
The argument is a set of changes to apply. It must describe a
161
valid result, but the order is not important. Specifically,
162
intermediate stages *may* be invalid, such as when two files
165
The changes should be structured as a list of tuples, of the form
166
(old_path, new_path, file_id, new_entry). For creation, old_path
167
must be None. For deletion, new_path and new_entry must be None.
168
file_id is always non-None. For renames and other mutations, all
169
values must be non-None.
171
If the new_entry is a directory, its children should be an empty
172
dict. Children are handled by apply_inventory_delta itself.
174
:param changes: A list of tuples for the change to apply:
175
[(old_path, new_path, file_id, new_inventory_entry), ...]
180
for old_path, file_id in sorted(((op, f) for op, np, f, e in changes
181
if op is not None), reverse=True):
182
if file_id not in inv:
184
children[file_id] = getattr(inv[file_id], 'children', {})
185
inv.remove_recursive_id(file_id)
186
for new_path, new_entry in sorted((np, e) for op, np, f, e in
187
changes if np is not None):
188
if getattr(new_entry, 'children', None) is not None:
189
new_entry.children = children.get(new_entry.file_id, {})
191
self._write_inventory(inv)
194
def commit(self, message=None, revprops=None, *args,
196
# avoid circular imports
197
from bzrlib import commit
200
if not 'branch-nick' in revprops:
201
revprops['branch-nick'] = self.branch.nick
202
# args for wt.commit start at message from the Commit.commit method,
203
args = (message, ) + args
204
committed_id = commit.Commit().commit(working_tree=self,
205
revprops=revprops, *args, **kwargs)
208
def _gather_kinds(self, files, kinds):
209
"""Helper function for add - sets the entries of kinds."""
210
raise NotImplementedError(self._gather_kinds)
213
def last_revision(self):
214
"""Return the revision id of the last commit performed in this tree.
216
In early tree formats the result of last_revision is the same as the
217
branch last_revision, but that is no longer the case for modern tree
220
last_revision returns the left most parent id, or None if there are no
223
last_revision was deprecated as of 0.11. Please use get_parent_ids
226
raise NotImplementedError(self.last_revision)
228
def lock_tree_write(self):
229
"""Lock the working tree for write, and the branch for read.
231
This is useful for operations which only need to mutate the working
232
tree. Taking out branch write locks is a relatively expensive process
233
and may fail if the branch is on read only media. So branch write locks
234
should only be taken out when we are modifying branch data - such as in
235
operations like commit, pull, uncommit and update.
237
raise NotImplementedError(self.lock_tree_write)
239
def lock_write(self):
240
"""Lock the tree and its branch. This allows mutating calls to be made.
242
Some mutating methods will take out implicit write locks, but in
243
general you should always obtain a write lock before calling mutating
246
raise NotImplementedError(self.lock_write)
249
def mkdir(self, path, file_id=None):
250
"""Create a directory in the tree. if file_id is None, one is assigned.
252
:param path: A unicode file path.
253
:param file_id: An optional file-id.
254
:return: the file id of the new directory.
256
raise NotImplementedError(self.mkdir)
258
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
259
"""Set the parents ids of the working tree.
261
:param revision_ids: A list of revision_ids.
263
raise NotImplementedError(self.set_parent_ids)
265
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
266
"""Set the parents of the working tree.
268
:param parents_list: A list of (revision_id, tree) tuples.
269
If tree is None, then that element is treated as an unreachable
270
parent tree - i.e. a ghost.
272
raise NotImplementedError(self.set_parent_trees)
274
@needs_tree_write_lock
275
def smart_add(self, file_list, recurse=True, action=None, save=True):
276
"""Version file_list, optionally recursing into directories.
278
This is designed more towards DWIM for humans than API clarity.
279
For the specific behaviour see the help for cmd_add().
281
Returns the number of files added.
283
:param action: A reporter to be called with the inventory, parent_ie,
284
path and kind of the path being added. It may return a file_id if
285
a specific one should be used.
286
:param save: Save the inventory after completing the adds. If False
287
this provides dry-run functionality by doing the add and not saving
288
the inventory. Note that the modified inventory is left in place,
289
allowing further dry-run tasks to take place. To restore the
290
original inventory call self.read_working_inventory().
292
# not in an inner loop; and we want to remove direct use of this,
293
# so here as a reminder for now. RBC 20070703
294
from bzrlib.inventory import InventoryEntry
295
assert isinstance(recurse, bool)
297
action = add.AddAction()
300
# no paths supplied: add the entire tree.
302
# mutter("smart add of %r")
309
# validate user file paths and convert all paths to tree
310
# relative : its cheaper to make a tree relative path an abspath
311
# than to convert an abspath to tree relative.
312
for filepath in file_list:
313
rf = _FastPath(self.relpath(filepath))
314
# validate user parameters. Our recursive code avoids adding new files
315
# that need such validation
316
if self.is_control_filename(rf.raw_path):
317
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
319
abspath = self.abspath(rf.raw_path)
320
kind = osutils.file_kind(abspath)
321
if kind == 'directory':
322
# schedule the dir for scanning
325
if not InventoryEntry.versionable_kind(kind):
326
raise errors.BadFileKindError(filename=abspath, kind=kind)
327
# ensure the named path is added, so that ignore rules in the later directory
329
# we dont have a parent ie known yet.: use the relatively slower inventory
331
versioned = inv.has_filename(rf.raw_path)
334
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
337
# no need to walk any directories at all.
338
if len(added) > 0 and save:
339
self._write_inventory(inv)
340
return added, ignored
342
# only walk the minimal parents needed: we have user_dirs to override
346
is_inside = osutils.is_inside_or_parent_of_any
347
for path in sorted(user_dirs):
348
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
349
dirs_to_add.append((path, None))
350
prev_dir = path.raw_path
352
# dirs_to_add is initialised to a list of directories, but as we scan
353
# directories we append files to it.
354
# XXX: We should determine kind of files when we scan them rather than
355
# adding to this list. RBC 20070703
356
for directory, parent_ie in dirs_to_add:
357
# directory is tree-relative
358
abspath = self.abspath(directory.raw_path)
360
# get the contents of this directory.
362
# find the kind of the path being added.
363
kind = osutils.file_kind(abspath)
365
if not InventoryEntry.versionable_kind(kind):
366
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
369
if parent_ie is not None:
370
versioned = directory.base_path in parent_ie.children
372
# without the parent ie, use the relatively slower inventory
374
versioned = inv.has_filename(directory.raw_path)
376
if kind == 'directory':
378
sub_branch = bzrdir.BzrDir.open(abspath)
380
except errors.NotBranchError:
382
except errors.UnsupportedFormatError:
387
if directory.raw_path == '':
388
# mutter("tree root doesn't need to be added")
392
# mutter("%r is already versioned", abspath)
394
# XXX: This is wrong; people *might* reasonably be trying to add
395
# subtrees as subtrees. This should probably only be done in formats
396
# which can represent subtrees, and even then perhaps only when
397
# the user asked to add subtrees. At the moment you can add them
398
# specially through 'join --reference', which is perhaps
399
# reasonable: adding a new reference is a special operation and
400
# can have a special behaviour. mbp 20070306
401
mutter("%r is a nested bzr tree", abspath)
403
_add_one(self, inv, parent_ie, directory, kind, action)
404
added.append(directory.raw_path)
406
if kind == 'directory' and not sub_tree:
407
if parent_ie is not None:
409
this_ie = parent_ie.children[directory.base_path]
411
# without the parent ie, use the relatively slower inventory
413
this_id = inv.path2id(directory.raw_path)
417
this_ie = inv[this_id]
419
for subf in sorted(os.listdir(abspath)):
420
# here we could use TreeDirectory rather than
421
# string concatenation.
422
subp = osutils.pathjoin(directory.raw_path, subf)
423
# TODO: is_control_filename is very slow. Make it faster.
424
# TreeDirectory.is_control_filename could also make this
425
# faster - its impossible for a non root dir to have a
427
if self.is_control_filename(subp):
428
mutter("skip control directory %r", subp)
429
elif subf in this_ie.children:
430
# recurse into this already versioned subdir.
431
dirs_to_add.append((_FastPath(subp, subf), this_ie))
433
# user selection overrides ignoes
434
# ignore while selecting files - if we globbed in the
435
# outer loop we would ignore user files.
436
ignore_glob = self.is_ignored(subp)
437
if ignore_glob is not None:
438
# mutter("skip ignored sub-file %r", subp)
439
ignored.setdefault(ignore_glob, []).append(subp)
441
#mutter("queue to add sub-file %r", subp)
442
dirs_to_add.append((_FastPath(subp, subf), this_ie))
444
if len(added) > 0 and save:
445
self._write_inventory(inv)
446
return added, ignored
449
class _FastPath(object):
450
"""A path object with fast accessors for things like basename."""
452
__slots__ = ['raw_path', 'base_path']
454
def __init__(self, path, base_path=None):
455
"""Construct a FastPath from path."""
456
if base_path is None:
457
self.base_path = osutils.basename(path)
459
self.base_path = base_path
462
def __cmp__(self, other):
463
return cmp(self.raw_path, other.raw_path)
466
return hash(self.raw_path)
469
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
470
"""Add a new entry to the inventory and automatically add unversioned parents.
472
:param inv: Inventory which will receive the new entry.
473
:param parent_ie: Parent inventory entry if known, or None. If
474
None, the parent is looked up by name and used if present, otherwise it
475
is recursively added.
476
:param kind: Kind of new entry (file, directory, etc)
477
:param action: callback(inv, parent_ie, path, kind); return ignored.
478
:return: A list of paths which have been added.
480
# Nothing to do if path is already versioned.
481
# This is safe from infinite recursion because the tree root is
483
if parent_ie is not None:
484
# we have a parent ie already
487
# slower but does not need parent_ie
488
if inv.has_filename(path.raw_path):
490
# its really not there : add the parent
491
# note that the dirname use leads to some extra str copying etc but as
492
# there are a limited number of dirs we can be nested under, it should
493
# generally find it very fast and not recurse after that.
494
added = _add_one_and_parent(tree, inv, None,
495
_FastPath(dirname(path.raw_path)), 'directory', action)
496
parent_id = inv.path2id(dirname(path.raw_path))
497
parent_ie = inv[parent_id]
498
_add_one(tree, inv, parent_ie, path, kind, action)
499
return added + [path.raw_path]
502
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
503
"""Add a new entry to the inventory.
505
:param inv: Inventory which will receive the new entry.
506
:param parent_ie: Parent inventory entry.
507
:param kind: Kind of new entry (file, directory, etc)
508
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
509
file_id or None to generate a new file id
512
file_id = file_id_callback(inv, parent_ie, path, kind)
513
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
