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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""MutableTree object.
19
See MutableTree for more details.
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
33
from bzrlib.osutils import dirname
34
from bzrlib.revisiontree import RevisionTree
35
from bzrlib.trace import mutter, warning
43
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
from bzrlib.osutils import splitpath
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.
78
def __init__(self, *args, **kw):
79
super(MutableTree, self).__init__(*args, **kw)
80
# Is this tree on a case-insensitive or case-preserving file-system?
81
# Sub-classes may initialize to False if they detect they are being
82
# used on media which doesn't differentiate the case of names.
83
self.case_sensitive = True
85
@needs_tree_write_lock
86
def add(self, files, ids=None, kinds=None):
87
"""Add paths to the set of versioned paths.
89
Note that the command line normally calls smart_add instead,
90
which can automatically recurse.
92
This adds the files to the inventory, so that they will be
93
recorded by the next commit.
95
:param files: List of paths to add, relative to the base of the tree.
96
:param ids: If set, use these instead of automatically generated ids.
97
Must be the same length as the list of files, but may
98
contain None for ids that are to be autogenerated.
99
:param kinds: Optional parameter to specify the kinds to be used for
102
TODO: Perhaps callback with the ids and paths as they're added.
104
if isinstance(files, basestring):
105
# XXX: Passing a single string is inconsistent and should be
107
if not (ids is None or isinstance(ids, basestring)):
108
raise AssertionError()
109
if not (kinds is None or isinstance(kinds, basestring)):
110
raise AssertionError()
114
if kinds is not None:
117
files = [path.strip('/') for path in files]
120
ids = [None] * len(files)
122
if not (len(ids) == len(files)):
123
raise AssertionError()
125
kinds = [None] * len(files)
126
elif not len(kinds) == len(files):
127
raise AssertionError()
129
# generic constraint checks:
130
if self.is_control_filename(f):
131
raise errors.ForbiddenControlFileError(filename=f)
133
# fill out file kinds for all files [not needed when we stop
134
# caring about the instantaneous file kind within a uncommmitted tree
136
self._gather_kinds(files, kinds)
137
self._add(files, ids, kinds)
139
def add_reference(self, sub_tree):
140
"""Add a TreeReference to the tree, pointing at sub_tree"""
141
raise errors.UnsupportedOperation(self.add_reference, self)
143
def _add_reference(self, sub_tree):
144
"""Standard add_reference implementation, for use by subclasses"""
146
sub_tree_path = self.relpath(sub_tree.basedir)
147
except errors.PathNotChild:
148
raise errors.BadReferenceTarget(self, sub_tree,
149
'Target not inside tree.')
150
sub_tree_id = sub_tree.get_root_id()
151
if sub_tree_id == self.get_root_id():
152
raise errors.BadReferenceTarget(self, sub_tree,
153
'Trees have the same root id.')
154
if sub_tree_id in self.inventory:
155
raise errors.BadReferenceTarget(self, sub_tree,
156
'Root id already present in tree')
157
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
159
def _add(self, files, ids, kinds):
160
"""Helper function for add - updates the inventory.
162
:param files: sequence of pathnames, relative to the tree root
163
:param ids: sequence of suggested ids for the files (may be None)
164
:param kinds: sequence of inventory kinds of the files (i.e. may
165
contain "tree-reference")
167
raise NotImplementedError(self._add)
169
@needs_tree_write_lock
170
def apply_inventory_delta(self, changes):
171
"""Apply changes to the inventory as an atomic operation.
173
:param changes: An inventory delta to apply to the working tree's
176
:seealso Inventory.apply_delta: For details on the changes parameter.
180
inv.apply_delta(changes)
181
self._write_inventory(inv)
184
def commit(self, message=None, revprops=None, *args,
186
# avoid circular imports
187
from bzrlib import commit
190
possible_master_transports=[]
191
if not 'branch-nick' in revprops:
192
revprops['branch-nick'] = self.branch._get_nick(
193
kwargs.get('local', False),
194
possible_master_transports)
195
authors = kwargs.pop('authors', None)
196
author = kwargs.pop('author', None)
197
if authors is not None:
198
if author is not None:
199
raise AssertionError('Specifying both author and authors '
200
'is not allowed. Specify just authors instead')
201
if 'author' in revprops or 'authors' in revprops:
202
# XXX: maybe we should just accept one of them?
203
raise AssertionError('author property given twice')
205
for individual in authors:
206
if '\n' in individual:
207
raise AssertionError('\\n is not a valid character '
208
'in an author identity')
209
revprops['authors'] = '\n'.join(authors)
210
if author is not None:
211
symbol_versioning.warn('The parameter author was deprecated'
212
' in version 1.13. Use authors instead',
214
if 'author' in revprops or 'authors' in revprops:
215
# XXX: maybe we should just accept one of them?
216
raise AssertionError('author property given twice')
218
raise AssertionError('\\n is not a valid character '
219
'in an author identity')
220
revprops['authors'] = author
221
# args for wt.commit start at message from the Commit.commit method,
222
args = (message, ) + args
223
for hook in MutableTree.hooks['start_commit']:
225
committed_id = commit.Commit().commit(working_tree=self,
227
possible_master_transports=possible_master_transports,
229
post_hook_params = PostCommitHookParams(self)
230
for hook in MutableTree.hooks['post_commit']:
231
hook(post_hook_params)
234
def _gather_kinds(self, files, kinds):
235
"""Helper function for add - sets the entries of kinds."""
236
raise NotImplementedError(self._gather_kinds)
239
def has_changes(self, from_tree):
240
"""Quickly check that the tree contains at least one change.
242
:return: True if a change is found. False otherwise
244
changes = self.iter_changes(from_tree)
246
change = changes.next()
247
# Exclude root (talk about black magic... --vila 20090629)
248
if change[4] == (None, None):
249
change = changes.next()
251
except StopIteration:
256
def last_revision(self):
257
"""Return the revision id of the last commit performed in this tree.
259
In early tree formats the result of last_revision is the same as the
260
branch last_revision, but that is no longer the case for modern tree
263
last_revision returns the left most parent id, or None if there are no
266
last_revision was deprecated as of 0.11. Please use get_parent_ids
269
raise NotImplementedError(self.last_revision)
271
def lock_tree_write(self):
272
"""Lock the working tree for write, and the branch for read.
274
This is useful for operations which only need to mutate the working
275
tree. Taking out branch write locks is a relatively expensive process
276
and may fail if the branch is on read only media. So branch write locks
277
should only be taken out when we are modifying branch data - such as in
278
operations like commit, pull, uncommit and update.
280
raise NotImplementedError(self.lock_tree_write)
282
def lock_write(self):
283
"""Lock the tree and its branch. This allows mutating calls to be made.
285
Some mutating methods will take out implicit write locks, but in
286
general you should always obtain a write lock before calling mutating
289
raise NotImplementedError(self.lock_write)
292
def mkdir(self, path, file_id=None):
293
"""Create a directory in the tree. if file_id is None, one is assigned.
295
:param path: A unicode file path.
296
:param file_id: An optional file-id.
297
:return: the file id of the new directory.
299
raise NotImplementedError(self.mkdir)
301
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
302
"""Tell the tree we have observed a paths sha1.
304
The intent of this function is to allow trees that have a hashcache to
305
update the hashcache during commit. If the observed file is too new
306
(based on the stat_value) to be safely hash-cached the tree will ignore
309
The default implementation does nothing.
311
:param file_id: The file id
312
:param path: The file path
313
:param sha1: The sha 1 that was observed.
314
:param stat_value: A stat result for the file the sha1 was read from.
318
def _fix_case_of_inventory_path(self, path):
319
"""If our tree isn't case sensitive, return the canonical path"""
320
if not self.case_sensitive:
321
path = self.get_canonical_inventory_path(path)
325
def put_file_bytes_non_atomic(self, file_id, bytes):
326
"""Update the content of a file in the tree.
328
Note that the file is written in-place rather than being
329
written to a temporary location and renamed. As a consequence,
330
readers can potentially see the file half-written.
332
:param file_id: file-id of the file
333
:param bytes: the new file contents
335
raise NotImplementedError(self.put_file_bytes_non_atomic)
337
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
338
"""Set the parents ids of the working tree.
340
:param revision_ids: A list of revision_ids.
342
raise NotImplementedError(self.set_parent_ids)
344
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
345
"""Set the parents of the working tree.
347
:param parents_list: A list of (revision_id, tree) tuples.
348
If tree is None, then that element is treated as an unreachable
349
parent tree - i.e. a ghost.
351
raise NotImplementedError(self.set_parent_trees)
353
@needs_tree_write_lock
354
def smart_add(self, file_list, recurse=True, action=None, save=True):
355
"""Version file_list, optionally recursing into directories.
357
This is designed more towards DWIM for humans than API clarity.
358
For the specific behaviour see the help for cmd_add().
360
:param action: A reporter to be called with the inventory, parent_ie,
361
path and kind of the path being added. It may return a file_id if
362
a specific one should be used.
363
:param save: Save the inventory after completing the adds. If False
364
this provides dry-run functionality by doing the add and not saving
366
:return: A tuple - files_added, ignored_files. files_added is the count
367
of added files, and ignored_files is a dict mapping files that were
368
ignored to the rule that caused them to be ignored.
370
# not in an inner loop; and we want to remove direct use of this,
371
# so here as a reminder for now. RBC 20070703
372
from bzrlib.inventory import InventoryEntry
374
action = add.AddAction()
377
# no paths supplied: add the entire tree.
379
# mutter("smart add of %r")
386
# validate user file paths and convert all paths to tree
387
# relative : it's cheaper to make a tree relative path an abspath
388
# than to convert an abspath to tree relative, and it's cheaper to
389
# perform the canonicalization in bulk.
390
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
391
rf = _FastPath(filepath)
392
# validate user parameters. Our recursive code avoids adding new files
393
# that need such validation
394
if self.is_control_filename(rf.raw_path):
395
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
397
abspath = self.abspath(rf.raw_path)
398
kind = osutils.file_kind(abspath)
399
if kind == 'directory':
400
# schedule the dir for scanning
403
if not InventoryEntry.versionable_kind(kind):
404
raise errors.BadFileKindError(filename=abspath, kind=kind)
405
# ensure the named path is added, so that ignore rules in the later directory
407
# we dont have a parent ie known yet.: use the relatively slower inventory
409
versioned = inv.has_filename(rf.raw_path)
412
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
415
# no need to walk any directories at all.
416
if len(added) > 0 and save:
417
self._write_inventory(inv)
418
return added, ignored
420
# only walk the minimal parents needed: we have user_dirs to override
424
is_inside = osutils.is_inside_or_parent_of_any
425
for path in sorted(user_dirs):
426
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
427
dirs_to_add.append((path, None))
428
prev_dir = path.raw_path
430
# dirs_to_add is initialised to a list of directories, but as we scan
431
# directories we append files to it.
432
# XXX: We should determine kind of files when we scan them rather than
433
# adding to this list. RBC 20070703
434
for directory, parent_ie in dirs_to_add:
435
# directory is tree-relative
436
abspath = self.abspath(directory.raw_path)
438
# get the contents of this directory.
440
# find the kind of the path being added.
441
kind = osutils.file_kind(abspath)
443
if not InventoryEntry.versionable_kind(kind):
444
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
447
if parent_ie is not None:
448
versioned = directory.base_path in parent_ie.children
450
# without the parent ie, use the relatively slower inventory
452
versioned = inv.has_filename(
453
self._fix_case_of_inventory_path(directory.raw_path))
455
if kind == 'directory':
457
sub_branch = bzrdir.BzrDir.open(abspath)
459
except errors.NotBranchError:
461
except errors.UnsupportedFormatError:
466
if directory.raw_path == '':
467
# mutter("tree root doesn't need to be added")
471
# mutter("%r is already versioned", abspath)
473
# XXX: This is wrong; people *might* reasonably be trying to add
474
# subtrees as subtrees. This should probably only be done in formats
475
# which can represent subtrees, and even then perhaps only when
476
# the user asked to add subtrees. At the moment you can add them
477
# specially through 'join --reference', which is perhaps
478
# reasonable: adding a new reference is a special operation and
479
# can have a special behaviour. mbp 20070306
480
mutter("%r is a nested bzr tree", abspath)
482
_add_one(self, inv, parent_ie, directory, kind, action)
483
added.append(directory.raw_path)
485
if kind == 'directory' and not sub_tree:
486
if parent_ie is not None:
488
this_ie = parent_ie.children[directory.base_path]
490
# without the parent ie, use the relatively slower inventory
492
this_id = inv.path2id(
493
self._fix_case_of_inventory_path(directory.raw_path))
497
this_ie = inv[this_id]
499
for subf in sorted(os.listdir(abspath)):
500
# here we could use TreeDirectory rather than
501
# string concatenation.
502
subp = osutils.pathjoin(directory.raw_path, subf)
503
# TODO: is_control_filename is very slow. Make it faster.
504
# TreeDirectory.is_control_filename could also make this
505
# faster - its impossible for a non root dir to have a
507
if self.is_control_filename(subp):
508
mutter("skip control directory %r", subp)
509
elif subf in this_ie.children:
510
# recurse into this already versioned subdir.
511
dirs_to_add.append((_FastPath(subp, subf), this_ie))
513
# user selection overrides ignoes
514
# ignore while selecting files - if we globbed in the
515
# outer loop we would ignore user files.
516
ignore_glob = self.is_ignored(subp)
517
if ignore_glob is not None:
518
# mutter("skip ignored sub-file %r", subp)
519
ignored.setdefault(ignore_glob, []).append(subp)
521
#mutter("queue to add sub-file %r", subp)
522
dirs_to_add.append((_FastPath(subp, subf), this_ie))
526
self._write_inventory(inv)
528
self.read_working_inventory()
529
return added, ignored
531
def update_basis_by_delta(self, new_revid, delta):
532
"""Update the parents of this tree after a commit.
534
This gives the tree one parent, with revision id new_revid. The
535
inventory delta is applied to the current basis tree to generate the
536
inventory for the parent new_revid, and all other parent trees are
539
All the changes in the delta should be changes synchronising the basis
540
tree with some or all of the working tree, with a change to a directory
541
requiring that its contents have been recursively included. That is,
542
this is not a general purpose tree modification routine, but a helper
543
for commit which is not required to handle situations that do not arise
546
See the inventory developers documentation for the theory behind
549
:param new_revid: The new revision id for the trees parent.
550
:param delta: An inventory delta (see apply_inventory_delta) describing
551
the changes from the current left most parent revision to new_revid.
553
# if the tree is updated by a pull to the branch, as happens in
554
# WorkingTree2, when there was no separation between branch and tree,
555
# then just clear merges, efficiency is not a concern for now as this
556
# is legacy environments only, and they are slow regardless.
557
if self.last_revision() == new_revid:
558
self.set_parent_ids([new_revid])
560
# generic implementation based on Inventory manipulation. See
561
# WorkingTree classes for optimised versions for specific format trees.
562
basis = self.basis_tree()
564
# TODO: Consider re-evaluating the need for this with CHKInventory
565
# we don't strictly need to mutate an inventory for this
566
# it only makes sense when apply_delta is cheaper than get_inventory()
567
inventory = basis.inventory._get_mutable_inventory()
569
inventory.apply_delta(delta)
570
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
571
self.set_parent_trees([(new_revid, rev_tree)])
574
class MutableTreeHooks(hooks.Hooks):
575
"""A dictionary mapping a hook name to a list of callables for mutabletree
580
"""Create the default hooks.
583
hooks.Hooks.__init__(self)
584
self.create_hook(hooks.HookPoint('start_commit',
585
"Called before a commit is performed on a tree. The start commit "
586
"hook is able to change the tree before the commit takes place. "
587
"start_commit is called with the bzrlib.mutabletree.MutableTree "
588
"that the commit is being performed on.", (1, 4), None))
589
self.create_hook(hooks.HookPoint('post_commit',
590
"Called after a commit is performed on a tree. The hook is "
591
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
592
"The mutable tree the commit was performed on is available via "
593
"the mutable_tree attribute of that object.", (2, 0), None))
596
# install the default hooks into the MutableTree class.
597
MutableTree.hooks = MutableTreeHooks()
600
class PostCommitHookParams(object):
601
"""Parameters for the post_commit hook.
603
To access the parameters, use the following attributes:
605
* mutable_tree - the MutableTree object
608
def __init__(self, mutable_tree):
609
"""Create the parameters for the post_commit hook."""
610
self.mutable_tree = mutable_tree
613
class _FastPath(object):
614
"""A path object with fast accessors for things like basename."""
616
__slots__ = ['raw_path', 'base_path']
618
def __init__(self, path, base_path=None):
619
"""Construct a FastPath from path."""
620
if base_path is None:
621
self.base_path = osutils.basename(path)
623
self.base_path = base_path
626
def __cmp__(self, other):
627
return cmp(self.raw_path, other.raw_path)
630
return hash(self.raw_path)
633
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
634
"""Add a new entry to the inventory and automatically add unversioned parents.
636
:param inv: Inventory which will receive the new entry.
637
:param parent_ie: Parent inventory entry if known, or None. If
638
None, the parent is looked up by name and used if present, otherwise it
639
is recursively added.
640
:param kind: Kind of new entry (file, directory, etc)
641
:param action: callback(inv, parent_ie, path, kind); return ignored.
642
:return: A list of paths which have been added.
644
# Nothing to do if path is already versioned.
645
# This is safe from infinite recursion because the tree root is
647
if parent_ie is not None:
648
# we have a parent ie already
651
# slower but does not need parent_ie
652
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
654
# its really not there : add the parent
655
# note that the dirname use leads to some extra str copying etc but as
656
# there are a limited number of dirs we can be nested under, it should
657
# generally find it very fast and not recurse after that.
658
added = _add_one_and_parent(tree, inv, None,
659
_FastPath(dirname(path.raw_path)), 'directory', action)
660
parent_id = inv.path2id(dirname(path.raw_path))
661
parent_ie = inv[parent_id]
662
_add_one(tree, inv, parent_ie, path, kind, action)
663
return added + [path.raw_path]
666
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
667
"""Add a new entry to the inventory.
669
:param inv: Inventory which will receive the new entry.
670
:param parent_ie: Parent inventory entry.
671
:param kind: Kind of new entry (file, directory, etc)
672
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
673
file_id or None to generate a new file id
676
file_id = file_id_callback(inv, parent_ie, path, kind)
677
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
