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
# XXX: Passing a single string is inconsistent and should be
101
if not (ids is None or isinstance(ids, basestring)):
102
raise AssertionError()
103
if not (kinds is None or isinstance(kinds, basestring)):
104
raise AssertionError()
108
if kinds is not None:
111
files = [path.strip('/') for path in files]
114
ids = [None] * len(files)
116
if not (len(ids) == len(files)):
117
raise AssertionError()
119
kinds = [None] * len(files)
120
elif not len(kinds) == len(files):
121
raise AssertionError()
123
# generic constraint checks:
124
if self.is_control_filename(f):
125
raise errors.ForbiddenControlFileError(filename=f)
127
# fill out file kinds for all files [not needed when we stop
128
# caring about the instantaneous file kind within a uncommmitted tree
130
self._gather_kinds(files, kinds)
131
self._add(files, ids, kinds)
133
def add_reference(self, sub_tree):
134
"""Add a TreeReference to the tree, pointing at sub_tree"""
135
raise errors.UnsupportedOperation(self.add_reference, self)
137
def _add_reference(self, sub_tree):
138
"""Standard add_reference implementation, for use by subclasses"""
140
sub_tree_path = self.relpath(sub_tree.basedir)
141
except errors.PathNotChild:
142
raise errors.BadReferenceTarget(self, sub_tree,
143
'Target not inside tree.')
144
sub_tree_id = sub_tree.get_root_id()
145
if sub_tree_id == self.get_root_id():
146
raise errors.BadReferenceTarget(self, sub_tree,
147
'Trees have the same root id.')
148
if sub_tree_id in self.inventory:
149
raise errors.BadReferenceTarget(self, sub_tree,
150
'Root id already present in tree')
151
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
153
def _add(self, files, ids, kinds):
154
"""Helper function for add - updates the inventory.
156
:param files: sequence of pathnames, relative to the tree root
157
:param ids: sequence of suggested ids for the files (may be None)
158
:param kinds: sequence of inventory kinds of the files (i.e. may
159
contain "tree-reference")
161
raise NotImplementedError(self._add)
163
@needs_tree_write_lock
164
def apply_inventory_delta(self, changes):
165
"""Apply changes to the inventory as an atomic operation.
167
:param changes: An inventory delta to apply to the working tree's
170
:seealso Inventory.apply_delta: For details on the changes parameter.
174
inv.apply_delta(changes)
175
self._write_inventory(inv)
178
def commit(self, message=None, revprops=None, *args,
180
# avoid circular imports
181
from bzrlib import commit
184
possible_master_transports=[]
185
if not 'branch-nick' in revprops:
186
revprops['branch-nick'] = self.branch._get_nick(
187
possible_master_transports)
188
author = kwargs.pop('author', None)
189
if author is not None:
190
if 'author' in revprops:
191
# XXX: maybe we should just accept one of them?
192
raise AssertionError('author property given twice')
193
revprops['author'] = author
194
# args for wt.commit start at message from the Commit.commit method,
195
args = (message, ) + args
196
for hook in MutableTree.hooks['start_commit']:
198
committed_id = commit.Commit().commit(working_tree=self,
200
possible_master_transports=possible_master_transports,
204
def _gather_kinds(self, files, kinds):
205
"""Helper function for add - sets the entries of kinds."""
206
raise NotImplementedError(self._gather_kinds)
208
def get_file_with_stat(self, file_id, path=None):
209
"""Get a file handle and stat object for file_id.
211
The default implementation returns (self.get_file, None) for backwards
214
:param file_id: The file id to read.
215
:param path: The path of the file, if it is known.
216
:return: A tuple (file_handle, stat_value_or_None). If the tree has
217
no stat facility, or need for a stat cache feedback during commit,
218
it may return None for the second element of the tuple.
220
return (self.get_file(file_id, path), None)
223
def last_revision(self):
224
"""Return the revision id of the last commit performed in this tree.
226
In early tree formats the result of last_revision is the same as the
227
branch last_revision, but that is no longer the case for modern tree
230
last_revision returns the left most parent id, or None if there are no
233
last_revision was deprecated as of 0.11. Please use get_parent_ids
236
raise NotImplementedError(self.last_revision)
238
def lock_tree_write(self):
239
"""Lock the working tree for write, and the branch for read.
241
This is useful for operations which only need to mutate the working
242
tree. Taking out branch write locks is a relatively expensive process
243
and may fail if the branch is on read only media. So branch write locks
244
should only be taken out when we are modifying branch data - such as in
245
operations like commit, pull, uncommit and update.
247
raise NotImplementedError(self.lock_tree_write)
249
def lock_write(self):
250
"""Lock the tree and its branch. This allows mutating calls to be made.
252
Some mutating methods will take out implicit write locks, but in
253
general you should always obtain a write lock before calling mutating
256
raise NotImplementedError(self.lock_write)
259
def mkdir(self, path, file_id=None):
260
"""Create a directory in the tree. if file_id is None, one is assigned.
262
:param path: A unicode file path.
263
:param file_id: An optional file-id.
264
:return: the file id of the new directory.
266
raise NotImplementedError(self.mkdir)
268
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
269
"""Tell the tree we have observed a paths sha1.
271
The intent of this function is to allow trees that have a hashcache to
272
update the hashcache during commit. If the observed file is too new
273
(based on the stat_value) to be safely hash-cached the tree will ignore
276
The default implementation does nothing.
278
:param file_id: The file id
279
:param path: The file path
280
:param sha1: The sha 1 that was observed.
281
:param stat_value: A stat result for the file the sha1 was read from.
286
def put_file_bytes_non_atomic(self, file_id, bytes):
287
"""Update the content of a file in the tree.
289
Note that the file is written in-place rather than being
290
written to a temporary location and renamed. As a consequence,
291
readers can potentially see the file half-written.
293
:param file_id: file-id of the file
294
:param bytes: the new file contents
296
raise NotImplementedError(self.put_file_bytes_non_atomic)
298
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
299
"""Set the parents ids of the working tree.
301
:param revision_ids: A list of revision_ids.
303
raise NotImplementedError(self.set_parent_ids)
305
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
306
"""Set the parents of the working tree.
308
:param parents_list: A list of (revision_id, tree) tuples.
309
If tree is None, then that element is treated as an unreachable
310
parent tree - i.e. a ghost.
312
raise NotImplementedError(self.set_parent_trees)
314
@needs_tree_write_lock
315
def smart_add(self, file_list, recurse=True, action=None, save=True):
316
"""Version file_list, optionally recursing into directories.
318
This is designed more towards DWIM for humans than API clarity.
319
For the specific behaviour see the help for cmd_add().
321
:param action: A reporter to be called with the inventory, parent_ie,
322
path and kind of the path being added. It may return a file_id if
323
a specific one should be used.
324
:param save: Save the inventory after completing the adds. If False
325
this provides dry-run functionality by doing the add and not saving
327
:return: A tuple - files_added, ignored_files. files_added is the count
328
of added files, and ignored_files is a dict mapping files that were
329
ignored to the rule that caused them to be ignored.
331
# not in an inner loop; and we want to remove direct use of this,
332
# so here as a reminder for now. RBC 20070703
333
from bzrlib.inventory import InventoryEntry
335
action = add.AddAction()
338
# no paths supplied: add the entire tree.
340
# mutter("smart add of %r")
347
# validate user file paths and convert all paths to tree
348
# relative : it's cheaper to make a tree relative path an abspath
349
# than to convert an abspath to tree relative.
350
for filepath in file_list:
351
rf = _FastPath(self.relpath(filepath))
352
# validate user parameters. Our recursive code avoids adding new files
353
# that need such validation
354
if self.is_control_filename(rf.raw_path):
355
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
357
abspath = self.abspath(rf.raw_path)
358
kind = osutils.file_kind(abspath)
359
if kind == 'directory':
360
# schedule the dir for scanning
363
if not InventoryEntry.versionable_kind(kind):
364
raise errors.BadFileKindError(filename=abspath, kind=kind)
365
# ensure the named path is added, so that ignore rules in the later directory
367
# we dont have a parent ie known yet.: use the relatively slower inventory
369
versioned = inv.has_filename(rf.raw_path)
372
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
375
# no need to walk any directories at all.
376
if len(added) > 0 and save:
377
self._write_inventory(inv)
378
return added, ignored
380
# only walk the minimal parents needed: we have user_dirs to override
384
is_inside = osutils.is_inside_or_parent_of_any
385
for path in sorted(user_dirs):
386
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
387
dirs_to_add.append((path, None))
388
prev_dir = path.raw_path
390
# dirs_to_add is initialised to a list of directories, but as we scan
391
# directories we append files to it.
392
# XXX: We should determine kind of files when we scan them rather than
393
# adding to this list. RBC 20070703
394
for directory, parent_ie in dirs_to_add:
395
# directory is tree-relative
396
abspath = self.abspath(directory.raw_path)
398
# get the contents of this directory.
400
# find the kind of the path being added.
401
kind = osutils.file_kind(abspath)
403
if not InventoryEntry.versionable_kind(kind):
404
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
407
if parent_ie is not None:
408
versioned = directory.base_path in parent_ie.children
410
# without the parent ie, use the relatively slower inventory
412
versioned = inv.has_filename(directory.raw_path)
414
if kind == 'directory':
416
sub_branch = bzrdir.BzrDir.open(abspath)
418
except errors.NotBranchError:
420
except errors.UnsupportedFormatError:
425
if directory.raw_path == '':
426
# mutter("tree root doesn't need to be added")
430
# mutter("%r is already versioned", abspath)
432
# XXX: This is wrong; people *might* reasonably be trying to add
433
# subtrees as subtrees. This should probably only be done in formats
434
# which can represent subtrees, and even then perhaps only when
435
# the user asked to add subtrees. At the moment you can add them
436
# specially through 'join --reference', which is perhaps
437
# reasonable: adding a new reference is a special operation and
438
# can have a special behaviour. mbp 20070306
439
mutter("%r is a nested bzr tree", abspath)
441
_add_one(self, inv, parent_ie, directory, kind, action)
442
added.append(directory.raw_path)
444
if kind == 'directory' and not sub_tree:
445
if parent_ie is not None:
447
this_ie = parent_ie.children[directory.base_path]
449
# without the parent ie, use the relatively slower inventory
451
this_id = inv.path2id(directory.raw_path)
455
this_ie = inv[this_id]
457
for subf in sorted(os.listdir(abspath)):
458
# here we could use TreeDirectory rather than
459
# string concatenation.
460
subp = osutils.pathjoin(directory.raw_path, subf)
461
# TODO: is_control_filename is very slow. Make it faster.
462
# TreeDirectory.is_control_filename could also make this
463
# faster - its impossible for a non root dir to have a
465
if self.is_control_filename(subp):
466
mutter("skip control directory %r", subp)
467
elif subf in this_ie.children:
468
# recurse into this already versioned subdir.
469
dirs_to_add.append((_FastPath(subp, subf), this_ie))
471
# user selection overrides ignoes
472
# ignore while selecting files - if we globbed in the
473
# outer loop we would ignore user files.
474
ignore_glob = self.is_ignored(subp)
475
if ignore_glob is not None:
476
# mutter("skip ignored sub-file %r", subp)
477
ignored.setdefault(ignore_glob, []).append(subp)
479
#mutter("queue to add sub-file %r", subp)
480
dirs_to_add.append((_FastPath(subp, subf), this_ie))
484
self._write_inventory(inv)
486
self.read_working_inventory()
487
return added, ignored
489
def update_basis_by_delta(self, new_revid, delta):
490
"""Update the parents of this tree after a commit.
492
This gives the tree one parent, with revision id new_revid. The
493
inventory delta is applied to the current basis tree to generate the
494
inventory for the parent new_revid, and all other parent trees are
497
All the changes in the delta should be changes synchronising the basis
498
tree with some or all of the working tree, with a change to a directory
499
requiring that its contents have been recursively included. That is,
500
this is not a general purpose tree modification routine, but a helper
501
for commit which is not required to handle situations that do not arise
504
:param new_revid: The new revision id for the trees parent.
505
:param delta: An inventory delta (see apply_inventory_delta) describing
506
the changes from the current left most parent revision to new_revid.
508
# if the tree is updated by a pull to the branch, as happens in
509
# WorkingTree2, when there was no separation between branch and tree,
510
# then just clear merges, efficiency is not a concern for now as this
511
# is legacy environments only, and they are slow regardless.
512
if self.last_revision() == new_revid:
513
self.set_parent_ids([new_revid])
515
# generic implementation based on Inventory manipulation. See
516
# WorkingTree classes for optimised versions for specific format trees.
517
basis = self.basis_tree()
519
inventory = basis.inventory
521
inventory.apply_delta(delta)
522
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
523
self.set_parent_trees([(new_revid, rev_tree)])
526
class MutableTreeHooks(hooks.Hooks):
527
"""A dictionary mapping a hook name to a list of callables for mutabletree
532
"""Create the default hooks.
535
hooks.Hooks.__init__(self)
536
# Invoked before a commit is done in a tree. New in 1.4
537
self['start_commit'] = []
540
# install the default hooks into the MutableTree class.
541
MutableTree.hooks = MutableTreeHooks()
544
class _FastPath(object):
545
"""A path object with fast accessors for things like basename."""
547
__slots__ = ['raw_path', 'base_path']
549
def __init__(self, path, base_path=None):
550
"""Construct a FastPath from path."""
551
if base_path is None:
552
self.base_path = osutils.basename(path)
554
self.base_path = base_path
557
def __cmp__(self, other):
558
return cmp(self.raw_path, other.raw_path)
561
return hash(self.raw_path)
564
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
565
"""Add a new entry to the inventory and automatically add unversioned parents.
567
:param inv: Inventory which will receive the new entry.
568
:param parent_ie: Parent inventory entry if known, or None. If
569
None, the parent is looked up by name and used if present, otherwise it
570
is recursively added.
571
:param kind: Kind of new entry (file, directory, etc)
572
:param action: callback(inv, parent_ie, path, kind); return ignored.
573
:return: A list of paths which have been added.
575
# Nothing to do if path is already versioned.
576
# This is safe from infinite recursion because the tree root is
578
if parent_ie is not None:
579
# we have a parent ie already
582
# slower but does not need parent_ie
583
if inv.has_filename(path.raw_path):
585
# its really not there : add the parent
586
# note that the dirname use leads to some extra str copying etc but as
587
# there are a limited number of dirs we can be nested under, it should
588
# generally find it very fast and not recurse after that.
589
added = _add_one_and_parent(tree, inv, None,
590
_FastPath(dirname(path.raw_path)), 'directory', action)
591
parent_id = inv.path2id(dirname(path.raw_path))
592
parent_ie = inv[parent_id]
593
_add_one(tree, inv, parent_ie, path, kind, action)
594
return added + [path.raw_path]
597
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
598
"""Add a new entry to the inventory.
600
:param inv: Inventory which will receive the new entry.
601
:param parent_ie: Parent inventory entry.
602
:param kind: Kind of new entry (file, directory, etc)
603
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
604
file_id or None to generate a new file id
607
file_id = file_id_callback(inv, parent_ie, path, kind)
608
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
