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(), """
34
from bzrlib.osutils import dirname
35
from bzrlib.revisiontree import RevisionTree
36
from bzrlib.trace import mutter, warning
44
from bzrlib.decorators import needs_read_lock, needs_write_lock
45
from bzrlib.osutils import splitpath
48
def needs_tree_write_lock(unbound):
49
"""Decorate unbound to take out and release a tree_write lock."""
50
def tree_write_locked(self, *args, **kwargs):
51
self.lock_tree_write()
53
return unbound(self, *args, **kwargs)
56
tree_write_locked.__doc__ = unbound.__doc__
57
tree_write_locked.__name__ = unbound.__name__
58
return tree_write_locked
61
class MutableTree(tree.Tree):
62
"""A MutableTree is a specialisation of Tree which is able to be mutated.
64
Generally speaking these mutations are only possible within a lock_write
65
context, and will revert if the lock is broken abnormally - but this cannot
66
be guaranteed - depending on the exact implementation of the mutable state.
68
The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
69
For tests we also have MemoryTree which is a MutableTree whose contents are
72
For now, we are not treating MutableTree as an interface to provide
73
conformance tests for - rather we are testing MemoryTree specifically, and
74
interface testing implementations of WorkingTree.
76
A mutable tree always has an associated Branch and BzrDir object - the
77
branch and bzrdir attributes.
79
def __init__(self, *args, **kw):
80
super(MutableTree, self).__init__(*args, **kw)
81
# Is this tree on a case-insensitive or case-preserving file-system?
82
# Sub-classes may initialize to False if they detect they are being
83
# used on media which doesn't differentiate the case of names.
84
self.case_sensitive = True
86
@needs_tree_write_lock
87
def add(self, files, ids=None, kinds=None):
88
"""Add paths to the set of versioned paths.
90
Note that the command line normally calls smart_add instead,
91
which can automatically recurse.
93
This adds the files to the inventory, so that they will be
94
recorded by the next commit.
96
:param files: List of paths to add, relative to the base of the tree.
97
:param ids: If set, use these instead of automatically generated ids.
98
Must be the same length as the list of files, but may
99
contain None for ids that are to be autogenerated.
100
:param kinds: Optional parameter to specify the kinds to be used for
103
TODO: Perhaps callback with the ids and paths as they're added.
105
if isinstance(files, basestring):
106
# XXX: Passing a single string is inconsistent and should be
108
if not (ids is None or isinstance(ids, basestring)):
109
raise AssertionError()
110
if not (kinds is None or isinstance(kinds, basestring)):
111
raise AssertionError()
115
if kinds is not None:
118
files = [path.strip('/') for path in files]
121
ids = [None] * len(files)
123
if not (len(ids) == len(files)):
124
raise AssertionError()
126
kinds = [None] * len(files)
127
elif not len(kinds) == len(files):
128
raise AssertionError()
130
# generic constraint checks:
131
if self.is_control_filename(f):
132
raise errors.ForbiddenControlFileError(filename=f)
134
# fill out file kinds for all files [not needed when we stop
135
# caring about the instantaneous file kind within a uncommmitted tree
137
self._gather_kinds(files, kinds)
138
self._add(files, ids, kinds)
140
def add_reference(self, sub_tree):
141
"""Add a TreeReference to the tree, pointing at sub_tree"""
142
raise errors.UnsupportedOperation(self.add_reference, self)
144
def _add_reference(self, sub_tree):
145
"""Standard add_reference implementation, for use by subclasses"""
147
sub_tree_path = self.relpath(sub_tree.basedir)
148
except errors.PathNotChild:
149
raise errors.BadReferenceTarget(self, sub_tree,
150
'Target not inside tree.')
151
sub_tree_id = sub_tree.get_root_id()
152
if sub_tree_id == self.get_root_id():
153
raise errors.BadReferenceTarget(self, sub_tree,
154
'Trees have the same root id.')
155
if sub_tree_id in self.inventory:
156
raise errors.BadReferenceTarget(self, sub_tree,
157
'Root id already present in tree')
158
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
160
def _add(self, files, ids, kinds):
161
"""Helper function for add - updates the inventory.
163
:param files: sequence of pathnames, relative to the tree root
164
:param ids: sequence of suggested ids for the files (may be None)
165
:param kinds: sequence of inventory kinds of the files (i.e. may
166
contain "tree-reference")
168
raise NotImplementedError(self._add)
170
@needs_tree_write_lock
171
def apply_inventory_delta(self, changes):
172
"""Apply changes to the inventory as an atomic operation.
174
:param changes: An inventory delta to apply to the working tree's
177
:seealso Inventory.apply_delta: For details on the changes parameter.
181
inv.apply_delta(changes)
182
self._write_inventory(inv)
185
def commit(self, message=None, revprops=None, *args,
187
# avoid circular imports
188
from bzrlib import commit
191
possible_master_transports=[]
192
if not 'branch-nick' in revprops:
193
revprops['branch-nick'] = self.branch._get_nick(
194
kwargs.get('local', False),
195
possible_master_transports)
196
authors = kwargs.pop('authors', None)
197
author = kwargs.pop('author', None)
198
if authors is not None:
199
if author is not None:
200
raise AssertionError('Specifying both author and authors '
201
'is not allowed. Specify just authors instead')
202
if 'author' in revprops or 'authors' in revprops:
203
# XXX: maybe we should just accept one of them?
204
raise AssertionError('author property given twice')
206
for individual in authors:
207
if '\n' in individual:
208
raise AssertionError('\\n is not a valid character '
209
'in an author identity')
210
revprops['authors'] = '\n'.join(authors)
211
if author is not None:
212
symbol_versioning.warn('The parameter author was deprecated'
213
' in version 1.13. Use authors instead',
215
if 'author' in revprops or 'authors' in revprops:
216
# XXX: maybe we should just accept one of them?
217
raise AssertionError('author property given twice')
219
raise AssertionError('\\n is not a valid character '
220
'in an author identity')
221
revprops['authors'] = author
222
# args for wt.commit start at message from the Commit.commit method,
223
args = (message, ) + args
224
for hook in MutableTree.hooks['start_commit']:
226
committed_id = commit.Commit().commit(working_tree=self,
228
possible_master_transports=possible_master_transports,
230
post_hook_params = PostCommitHookParams(self)
231
for hook in MutableTree.hooks['post_commit']:
232
hook(post_hook_params)
235
def _gather_kinds(self, files, kinds):
236
"""Helper function for add - sets the entries of kinds."""
237
raise NotImplementedError(self._gather_kinds)
240
def has_changes(self, from_tree):
241
"""Quickly check that the tree contains at least one change.
243
:return: True if a change is found. False otherwise
245
changes = self.iter_changes(from_tree)
247
change = changes.next()
248
# Exclude root (talk about black magic... --vila 20090629)
249
if change[4] == (None, None):
250
change = changes.next()
252
except StopIteration:
257
def last_revision(self):
258
"""Return the revision id of the last commit performed in this tree.
260
In early tree formats the result of last_revision is the same as the
261
branch last_revision, but that is no longer the case for modern tree
264
last_revision returns the left most parent id, or None if there are no
267
last_revision was deprecated as of 0.11. Please use get_parent_ids
270
raise NotImplementedError(self.last_revision)
272
def lock_tree_write(self):
273
"""Lock the working tree for write, and the branch for read.
275
This is useful for operations which only need to mutate the working
276
tree. Taking out branch write locks is a relatively expensive process
277
and may fail if the branch is on read only media. So branch write locks
278
should only be taken out when we are modifying branch data - such as in
279
operations like commit, pull, uncommit and update.
281
raise NotImplementedError(self.lock_tree_write)
283
def lock_write(self):
284
"""Lock the tree and its branch. This allows mutating calls to be made.
286
Some mutating methods will take out implicit write locks, but in
287
general you should always obtain a write lock before calling mutating
290
raise NotImplementedError(self.lock_write)
293
def mkdir(self, path, file_id=None):
294
"""Create a directory in the tree. if file_id is None, one is assigned.
296
:param path: A unicode file path.
297
:param file_id: An optional file-id.
298
:return: the file id of the new directory.
300
raise NotImplementedError(self.mkdir)
302
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
303
"""Tell the tree we have observed a paths sha1.
305
The intent of this function is to allow trees that have a hashcache to
306
update the hashcache during commit. If the observed file is too new
307
(based on the stat_value) to be safely hash-cached the tree will ignore
310
The default implementation does nothing.
312
:param file_id: The file id
313
:param path: The file path
314
:param sha1: The sha 1 that was observed.
315
:param stat_value: A stat result for the file the sha1 was read from.
319
def _fix_case_of_inventory_path(self, path):
320
"""If our tree isn't case sensitive, return the canonical path"""
321
if not self.case_sensitive:
322
path = self.get_canonical_inventory_path(path)
326
def put_file_bytes_non_atomic(self, file_id, bytes):
327
"""Update the content of a file in the tree.
329
Note that the file is written in-place rather than being
330
written to a temporary location and renamed. As a consequence,
331
readers can potentially see the file half-written.
333
:param file_id: file-id of the file
334
:param bytes: the new file contents
336
raise NotImplementedError(self.put_file_bytes_non_atomic)
338
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
339
"""Set the parents ids of the working tree.
341
:param revision_ids: A list of revision_ids.
343
raise NotImplementedError(self.set_parent_ids)
345
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
346
"""Set the parents of the working tree.
348
:param parents_list: A list of (revision_id, tree) tuples.
349
If tree is None, then that element is treated as an unreachable
350
parent tree - i.e. a ghost.
352
raise NotImplementedError(self.set_parent_trees)
354
@needs_tree_write_lock
355
def smart_add(self, file_list, recurse=True, action=None, save=True):
356
"""Version file_list, optionally recursing into directories.
358
This is designed more towards DWIM for humans than API clarity.
359
For the specific behaviour see the help for cmd_add().
361
:param action: A reporter to be called with the inventory, parent_ie,
362
path and kind of the path being added. It may return a file_id if
363
a specific one should be used.
364
:param save: Save the inventory after completing the adds. If False
365
this provides dry-run functionality by doing the add and not saving
367
:return: A tuple - files_added, ignored_files. files_added is the count
368
of added files, and ignored_files is a dict mapping files that were
369
ignored to the rule that caused them to be ignored.
371
# not in an inner loop; and we want to remove direct use of this,
372
# so here as a reminder for now. RBC 20070703
373
from bzrlib.inventory import InventoryEntry
375
action = add.AddAction()
378
# no paths supplied: add the entire tree.
380
# mutter("smart add of %r")
387
# validate user file paths and convert all paths to tree
388
# relative : it's cheaper to make a tree relative path an abspath
389
# than to convert an abspath to tree relative, and it's cheaper to
390
# perform the canonicalization in bulk.
391
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
392
rf = _FastPath(filepath)
393
# validate user parameters. Our recursive code avoids adding new files
394
# that need such validation
395
if self.is_control_filename(rf.raw_path):
396
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
398
abspath = self.abspath(rf.raw_path)
399
kind = osutils.file_kind(abspath)
400
if kind == 'directory':
401
# schedule the dir for scanning
404
if not InventoryEntry.versionable_kind(kind):
405
raise errors.BadFileKindError(filename=abspath, kind=kind)
406
# ensure the named path is added, so that ignore rules in the later directory
408
# we dont have a parent ie known yet.: use the relatively slower inventory
410
versioned = inv.has_filename(rf.raw_path)
413
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
416
# no need to walk any directories at all.
417
if len(added) > 0 and save:
418
self._write_inventory(inv)
419
return added, ignored
421
# only walk the minimal parents needed: we have user_dirs to override
425
is_inside = osutils.is_inside_or_parent_of_any
426
for path in sorted(user_dirs):
427
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
428
dirs_to_add.append((path, None))
429
prev_dir = path.raw_path
431
illegalpath_re = re.compile(r'[\r\n]')
432
# dirs_to_add is initialised to a list of directories, but as we scan
433
# directories we append files to it.
434
# XXX: We should determine kind of files when we scan them rather than
435
# adding to this list. RBC 20070703
436
for directory, parent_ie in dirs_to_add:
437
# directory is tree-relative
438
abspath = self.abspath(directory.raw_path)
440
# get the contents of this directory.
442
# find the kind of the path being added.
443
kind = osutils.file_kind(abspath)
445
if not InventoryEntry.versionable_kind(kind):
446
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
448
if illegalpath_re.search(directory.raw_path):
449
warning("skipping %r (contains \\n or \\r)" % abspath)
452
if parent_ie is not None:
453
versioned = directory.base_path in parent_ie.children
455
# without the parent ie, use the relatively slower inventory
457
versioned = inv.has_filename(
458
self._fix_case_of_inventory_path(directory.raw_path))
460
if kind == 'directory':
462
sub_branch = bzrdir.BzrDir.open(abspath)
464
except errors.NotBranchError:
466
except errors.UnsupportedFormatError:
471
if directory.raw_path == '':
472
# mutter("tree root doesn't need to be added")
476
# mutter("%r is already versioned", abspath)
478
# XXX: This is wrong; people *might* reasonably be trying to add
479
# subtrees as subtrees. This should probably only be done in formats
480
# which can represent subtrees, and even then perhaps only when
481
# the user asked to add subtrees. At the moment you can add them
482
# specially through 'join --reference', which is perhaps
483
# reasonable: adding a new reference is a special operation and
484
# can have a special behaviour. mbp 20070306
485
mutter("%r is a nested bzr tree", abspath)
487
_add_one(self, inv, parent_ie, directory, kind, action)
488
added.append(directory.raw_path)
490
if kind == 'directory' and not sub_tree:
491
if parent_ie is not None:
493
this_ie = parent_ie.children[directory.base_path]
495
# without the parent ie, use the relatively slower inventory
497
this_id = inv.path2id(
498
self._fix_case_of_inventory_path(directory.raw_path))
502
this_ie = inv[this_id]
504
for subf in sorted(os.listdir(abspath)):
505
# here we could use TreeDirectory rather than
506
# string concatenation.
507
subp = osutils.pathjoin(directory.raw_path, subf)
508
# TODO: is_control_filename is very slow. Make it faster.
509
# TreeDirectory.is_control_filename could also make this
510
# faster - its impossible for a non root dir to have a
512
if self.is_control_filename(subp):
513
mutter("skip control directory %r", subp)
514
elif subf in this_ie.children:
515
# recurse into this already versioned subdir.
516
dirs_to_add.append((_FastPath(subp, subf), this_ie))
518
# user selection overrides ignoes
519
# ignore while selecting files - if we globbed in the
520
# outer loop we would ignore user files.
521
ignore_glob = self.is_ignored(subp)
522
if ignore_glob is not None:
523
# mutter("skip ignored sub-file %r", subp)
524
ignored.setdefault(ignore_glob, []).append(subp)
526
#mutter("queue to add sub-file %r", subp)
527
dirs_to_add.append((_FastPath(subp, subf), this_ie))
531
self._write_inventory(inv)
533
self.read_working_inventory()
534
return added, ignored
536
def update_basis_by_delta(self, new_revid, delta):
537
"""Update the parents of this tree after a commit.
539
This gives the tree one parent, with revision id new_revid. The
540
inventory delta is applied to the current basis tree to generate the
541
inventory for the parent new_revid, and all other parent trees are
544
All the changes in the delta should be changes synchronising the basis
545
tree with some or all of the working tree, with a change to a directory
546
requiring that its contents have been recursively included. That is,
547
this is not a general purpose tree modification routine, but a helper
548
for commit which is not required to handle situations that do not arise
551
See the inventory developers documentation for the theory behind
554
:param new_revid: The new revision id for the trees parent.
555
:param delta: An inventory delta (see apply_inventory_delta) describing
556
the changes from the current left most parent revision to new_revid.
558
# if the tree is updated by a pull to the branch, as happens in
559
# WorkingTree2, when there was no separation between branch and tree,
560
# then just clear merges, efficiency is not a concern for now as this
561
# is legacy environments only, and they are slow regardless.
562
if self.last_revision() == new_revid:
563
self.set_parent_ids([new_revid])
565
# generic implementation based on Inventory manipulation. See
566
# WorkingTree classes for optimised versions for specific format trees.
567
basis = self.basis_tree()
569
# TODO: Consider re-evaluating the need for this with CHKInventory
570
# we don't strictly need to mutate an inventory for this
571
# it only makes sense when apply_delta is cheaper than get_inventory()
572
inventory = basis.inventory._get_mutable_inventory()
574
inventory.apply_delta(delta)
575
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
576
self.set_parent_trees([(new_revid, rev_tree)])
579
class MutableTreeHooks(hooks.Hooks):
580
"""A dictionary mapping a hook name to a list of callables for mutabletree
585
"""Create the default hooks.
588
hooks.Hooks.__init__(self)
589
self.create_hook(hooks.HookPoint('start_commit',
590
"Called before a commit is performed on a tree. The start commit "
591
"hook is able to change the tree before the commit takes place. "
592
"start_commit is called with the bzrlib.mutabletree.MutableTree "
593
"that the commit is being performed on.", (1, 4), None))
594
self.create_hook(hooks.HookPoint('post_commit',
595
"Called after a commit is performed on a tree. The hook is "
596
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
597
"The mutable tree the commit was performed on is available via "
598
"the mutable_tree attribute of that object.", (2, 0), None))
601
# install the default hooks into the MutableTree class.
602
MutableTree.hooks = MutableTreeHooks()
605
class PostCommitHookParams(object):
606
"""Parameters for the post_commit hook.
608
To access the parameters, use the following attributes:
610
* mutable_tree - the MutableTree object
613
def __init__(self, mutable_tree):
614
"""Create the parameters for the post_commit hook."""
615
self.mutable_tree = mutable_tree
618
class _FastPath(object):
619
"""A path object with fast accessors for things like basename."""
621
__slots__ = ['raw_path', 'base_path']
623
def __init__(self, path, base_path=None):
624
"""Construct a FastPath from path."""
625
if base_path is None:
626
self.base_path = osutils.basename(path)
628
self.base_path = base_path
631
def __cmp__(self, other):
632
return cmp(self.raw_path, other.raw_path)
635
return hash(self.raw_path)
638
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
639
"""Add a new entry to the inventory and automatically add unversioned parents.
641
:param inv: Inventory which will receive the new entry.
642
:param parent_ie: Parent inventory entry if known, or None. If
643
None, the parent is looked up by name and used if present, otherwise it
644
is recursively added.
645
:param kind: Kind of new entry (file, directory, etc)
646
:param action: callback(inv, parent_ie, path, kind); return ignored.
647
:return: A list of paths which have been added.
649
# Nothing to do if path is already versioned.
650
# This is safe from infinite recursion because the tree root is
652
if parent_ie is not None:
653
# we have a parent ie already
656
# slower but does not need parent_ie
657
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
659
# its really not there : add the parent
660
# note that the dirname use leads to some extra str copying etc but as
661
# there are a limited number of dirs we can be nested under, it should
662
# generally find it very fast and not recurse after that.
663
added = _add_one_and_parent(tree, inv, None,
664
_FastPath(dirname(path.raw_path)), 'directory', action)
665
parent_id = inv.path2id(dirname(path.raw_path))
666
parent_ie = inv[parent_id]
667
_add_one(tree, inv, parent_ie, path, kind, action)
668
return added + [path.raw_path]
671
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
672
"""Add a new entry to the inventory.
674
:param inv: Inventory which will receive the new entry.
675
:param parent_ie: Parent inventory entry.
676
:param kind: Kind of new entry (file, directory, etc)
677
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
678
file_id or None to generate a new file id
681
file_id = file_id_callback(inv, parent_ie, path, kind)
682
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
