13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""MutableTree object.
23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
28
27
from bzrlib import (
31
from bzrlib.osutils import dirname
32
from bzrlib.revisiontree import RevisionTree
33
from bzrlib.trace import mutter, warning
41
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
42
from bzrlib.osutils import splitpath
43
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
44
46
def needs_tree_write_lock(unbound):
66
68
entirely in memory.
68
70
For now, we are not treating MutableTree as an interface to provide
69
conformance tests for - rather we are testing MemoryTree specifically, and
71
conformance tests for - rather we are testing MemoryTree specifically, and
70
72
interface testing implementations of WorkingTree.
72
74
A mutable tree always has an associated Branch and BzrDir object - the
73
75
branch and bzrdir attributes.
75
def __init__(self, *args, **kw):
76
super(MutableTree, self).__init__(*args, **kw)
77
# Is this tree on a case-insensitive or case-preserving file-system?
78
# Sub-classes may initialize to False if they detect they are being
79
# used on media which doesn't differentiate the case of names.
80
self.case_sensitive = True
82
78
@needs_tree_write_lock
83
79
def add(self, files, ids=None, kinds=None):
99
95
TODO: Perhaps callback with the ids and paths as they're added.
101
97
if isinstance(files, basestring):
102
# XXX: Passing a single string is inconsistent and should be
104
if not (ids is None or isinstance(ids, basestring)):
105
raise AssertionError()
106
if not (kinds is None or isinstance(kinds, basestring)):
107
raise AssertionError()
98
assert(ids is None or isinstance(ids, basestring))
99
assert(kinds is None or isinstance(kinds, basestring))
109
101
if ids is not None:
117
109
ids = [None] * len(files)
119
if not (len(ids) == len(files)):
120
raise AssertionError()
111
assert(len(ids) == len(files))
112
ids = [osutils.safe_file_id(file_id) for file_id in ids]
121
114
if kinds is None:
122
115
kinds = [None] * len(files)
123
elif not len(kinds) == len(files):
124
raise AssertionError()
117
assert(len(kinds) == len(files))
126
119
# generic constraint checks:
127
120
if self.is_control_filename(f):
128
121
raise errors.ForbiddenControlFileError(filename=f)
129
fp = osutils.splitpath(f)
130
# fill out file kinds for all files [not needed when we stop
123
# fill out file kinds for all files [not needed when we stop
131
124
# caring about the instantaneous file kind within a uncommmitted tree
133
126
self._gather_kinds(files, kinds)
183
176
# avoid circular imports
184
177
from bzrlib import commit
185
possible_master_transports=[]
186
revprops = commit.Commit.update_revprops(
189
kwargs.pop('authors', None),
190
kwargs.pop('author', None),
191
kwargs.get('local', False),
192
possible_master_transports)
180
if not 'branch-nick' in revprops:
181
revprops['branch-nick'] = self.branch.nick
182
author = kwargs.pop('author', None)
183
if author is not None:
184
assert 'author' not in revprops
185
revprops['author'] = author
193
186
# args for wt.commit start at message from the Commit.commit method,
194
187
args = (message, ) + args
195
for hook in MutableTree.hooks['start_commit']:
197
188
committed_id = commit.Commit().commit(working_tree=self,
199
possible_master_transports=possible_master_transports,
201
post_hook_params = PostCommitHookParams(self)
202
for hook in MutableTree.hooks['post_commit']:
203
hook(post_hook_params)
189
revprops=revprops, *args, **kwargs)
204
190
return committed_id
206
192
def _gather_kinds(self, files, kinds):
208
194
raise NotImplementedError(self._gather_kinds)
211
def has_changes(self, _from_tree=None):
212
"""Quickly check that the tree contains at least one commitable change.
214
:param _from_tree: tree to compare against to find changes (default to
215
the basis tree and is intended to be used by tests).
217
:return: True if a change is found. False otherwise
219
# Check pending merges
220
if len(self.get_parent_ids()) > 1:
222
if _from_tree is None:
223
_from_tree = self.basis_tree()
224
changes = self.iter_changes(_from_tree)
226
change = changes.next()
227
# Exclude root (talk about black magic... --vila 20090629)
228
if change[4] == (None, None):
229
change = changes.next()
231
except StopIteration:
236
def check_changed_or_out_of_date(self, strict, opt_name,
237
more_error, more_warning):
238
"""Check the tree for uncommitted changes and branch synchronization.
240
If strict is None and not set in the config files, a warning is issued.
241
If strict is True, an error is raised.
242
If strict is False, no checks are done and no warning is issued.
244
:param strict: True, False or None, searched in branch config if None.
246
:param opt_name: strict option name to search in config file.
248
:param more_error: Details about how to avoid the check.
250
:param more_warning: Details about what is happening.
253
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
254
if strict is not False:
256
if (self.has_changes()):
257
err_class = errors.UncommittedChanges
258
elif self.last_revision() != self.branch.last_revision():
259
# The tree has lost sync with its branch, there is little
260
# chance that the user is aware of it but he can still force
261
# the action with --no-strict
262
err_class = errors.OutOfDateTree
263
if err_class is not None:
265
err = err_class(self, more=more_warning)
266
# We don't want to interrupt the user if he expressed no
267
# preference about strict.
268
trace.warning('%s', err._format())
270
err = err_class(self, more=more_error)
274
197
def last_revision(self):
275
198
"""Return the revision id of the last commit performed in this tree.
277
200
In early tree formats the result of last_revision is the same as the
278
201
branch last_revision, but that is no longer the case for modern tree
281
204
last_revision returns the left most parent id, or None if there are no
317
240
raise NotImplementedError(self.mkdir)
319
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
320
"""Tell the tree we have observed a paths sha1.
322
The intent of this function is to allow trees that have a hashcache to
323
update the hashcache during commit. If the observed file is too new
324
(based on the stat_value) to be safely hash-cached the tree will ignore
327
The default implementation does nothing.
329
:param file_id: The file id
330
:param path: The file path
331
:param sha1: The sha 1 that was observed.
332
:param stat_value: A stat result for the file the sha1 was read from.
336
def _fix_case_of_inventory_path(self, path):
337
"""If our tree isn't case sensitive, return the canonical path"""
338
if not self.case_sensitive:
339
path = self.get_canonical_inventory_path(path)
343
def put_file_bytes_non_atomic(self, file_id, bytes):
344
"""Update the content of a file in the tree.
346
Note that the file is written in-place rather than being
347
written to a temporary location and renamed. As a consequence,
348
readers can potentially see the file half-written.
350
:param file_id: file-id of the file
351
:param bytes: the new file contents
353
raise NotImplementedError(self.put_file_bytes_non_atomic)
355
242
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
356
243
"""Set the parents ids of the working tree.
362
249
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
363
250
"""Set the parents of the working tree.
365
:param parents_list: A list of (revision_id, tree) tuples.
252
:param parents_list: A list of (revision_id, tree) tuples.
366
253
If tree is None, then that element is treated as an unreachable
367
254
parent tree - i.e. a ghost.
376
263
For the specific behaviour see the help for cmd_add().
378
265
:param action: A reporter to be called with the inventory, parent_ie,
379
path and kind of the path being added. It may return a file_id if
266
path and kind of the path being added. It may return a file_id if
380
267
a specific one should be used.
381
268
:param save: Save the inventory after completing the adds. If False
382
269
this provides dry-run functionality by doing the add and not saving
388
275
# not in an inner loop; and we want to remove direct use of this,
389
276
# so here as a reminder for now. RBC 20070703
390
277
from bzrlib.inventory import InventoryEntry
278
assert isinstance(recurse, bool)
391
279
if action is None:
392
280
action = add.AddAction()
394
282
if not file_list:
395
283
# no paths supplied: add the entire tree.
396
# FIXME: this assumes we are running in a working tree subdir :-/
398
284
file_list = [u'.']
399
285
# mutter("smart add of %r")
400
286
inv = self.inventory
404
290
user_dirs = set()
405
conflicts_related = set()
406
# Not all mutable trees can have conflicts
407
if getattr(self, 'conflicts', None) is not None:
408
# Collect all related files without checking whether they exist or
409
# are versioned. It's cheaper to do that once for all conflicts
410
# than trying to find the relevant conflict for each added file.
411
for c in self.conflicts():
412
conflicts_related.update(c.associated_filenames())
414
# validate user file paths and convert all paths to tree
292
# validate user file paths and convert all paths to tree
415
293
# relative : it's cheaper to make a tree relative path an abspath
416
# than to convert an abspath to tree relative, and it's cheaper to
417
# perform the canonicalization in bulk.
418
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
419
rf = _FastPath(filepath)
420
# validate user parameters. Our recursive code avoids adding new
421
# files that need such validation
294
# than to convert an abspath to tree relative.
295
for filepath in file_list:
296
rf = _FastPath(self.relpath(filepath))
297
# validate user parameters. Our recursive code avoids adding new files
298
# that need such validation
422
299
if self.is_control_filename(rf.raw_path):
423
300
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
425
302
abspath = self.abspath(rf.raw_path)
426
303
kind = osutils.file_kind(abspath)
427
304
if kind == 'directory':
431
308
if not InventoryEntry.versionable_kind(kind):
432
309
raise errors.BadFileKindError(filename=abspath, kind=kind)
433
# ensure the named path is added, so that ignore rules in the later
434
# directory walk dont skip it.
435
# we dont have a parent ie known yet.: use the relatively slower
436
# inventory probing method
310
# ensure the named path is added, so that ignore rules in the later directory
312
# we dont have a parent ie known yet.: use the relatively slower inventory
437
314
versioned = inv.has_filename(rf.raw_path)
455
332
dirs_to_add.append((path, None))
456
333
prev_dir = path.raw_path
458
illegalpath_re = re.compile(r'[\r\n]')
459
335
# dirs_to_add is initialised to a list of directories, but as we scan
460
336
# directories we append files to it.
461
337
# XXX: We should determine kind of files when we scan them rather than
470
346
kind = osutils.file_kind(abspath)
472
348
if not InventoryEntry.versionable_kind(kind):
473
trace.warning("skipping %s (can't add file of kind '%s')",
476
if illegalpath_re.search(directory.raw_path):
477
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
479
if directory.raw_path in conflicts_related:
480
# If the file looks like one generated for a conflict, don't
483
'skipping %s (generated to help resolve conflicts)',
349
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
487
352
if parent_ie is not None:
488
353
versioned = directory.base_path in parent_ie.children
490
# without the parent ie, use the relatively slower inventory
355
# without the parent ie, use the relatively slower inventory
492
versioned = inv.has_filename(
493
self._fix_case_of_inventory_path(directory.raw_path))
357
versioned = inv.has_filename(directory.raw_path)
495
359
if kind == 'directory':
511
375
# mutter("%r is already versioned", abspath)
513
# XXX: This is wrong; people *might* reasonably be trying to
514
# add subtrees as subtrees. This should probably only be done
515
# in formats which can represent subtrees, and even then
516
# perhaps only when the user asked to add subtrees. At the
517
# moment you can add them specially through 'join --reference',
518
# which is perhaps reasonable: adding a new reference is a
519
# special operation and can have a special behaviour. mbp
521
trace.mutter("%r is a nested bzr tree", abspath)
377
# XXX: This is wrong; people *might* reasonably be trying to add
378
# subtrees as subtrees. This should probably only be done in formats
379
# which can represent subtrees, and even then perhaps only when
380
# the user asked to add subtrees. At the moment you can add them
381
# specially through 'join --reference', which is perhaps
382
# reasonable: adding a new reference is a special operation and
383
# can have a special behaviour. mbp 20070306
384
mutter("%r is a nested bzr tree", abspath)
523
386
_add_one(self, inv, parent_ie, directory, kind, action)
524
387
added.append(directory.raw_path)
528
391
# must be present:
529
392
this_ie = parent_ie.children[directory.base_path]
531
# without the parent ie, use the relatively slower inventory
394
# without the parent ie, use the relatively slower inventory
533
this_id = inv.path2id(
534
self._fix_case_of_inventory_path(directory.raw_path))
396
this_id = inv.path2id(directory.raw_path)
535
397
if this_id is None:
538
400
this_ie = inv[this_id]
540
402
for subf in sorted(os.listdir(abspath)):
541
# here we could use TreeDirectory rather than
403
# here we could use TreeDirectory rather than
542
404
# string concatenation.
543
405
subp = osutils.pathjoin(directory.raw_path, subf)
544
# TODO: is_control_filename is very slow. Make it faster.
545
# TreeDirectory.is_control_filename could also make this
546
# faster - its impossible for a non root dir to have a
406
# TODO: is_control_filename is very slow. Make it faster.
407
# TreeDirectory.is_control_filename could also make this
408
# faster - its impossible for a non root dir to have a
548
410
if self.is_control_filename(subp):
549
trace.mutter("skip control directory %r", subp)
411
mutter("skip control directory %r", subp)
550
412
elif subf in this_ie.children:
551
413
# recurse into this already versioned subdir.
552
414
dirs_to_add.append((_FastPath(subp, subf), this_ie))
569
431
self.read_working_inventory()
570
432
return added, ignored
572
def update_basis_by_delta(self, new_revid, delta):
434
def update_to_one_parent_via_delta(self, new_revid, delta):
573
435
"""Update the parents of this tree after a commit.
575
437
This gives the tree one parent, with revision id new_revid. The
576
inventory delta is applied to the current basis tree to generate the
438
inventory delta is applied ot the current basis tree to generate the
577
439
inventory for the parent new_revid, and all other parent trees are
580
All the changes in the delta should be changes synchronising the basis
581
tree with some or all of the working tree, with a change to a directory
582
requiring that its contents have been recursively included. That is,
583
this is not a general purpose tree modification routine, but a helper
584
for commit which is not required to handle situations that do not arise
587
See the inventory developers documentation for the theory behind
590
442
:param new_revid: The new revision id for the trees parent.
591
443
:param delta: An inventory delta (see apply_inventory_delta) describing
592
444
the changes from the current left most parent revision to new_revid.
602
454
# WorkingTree classes for optimised versions for specific format trees.
603
455
basis = self.basis_tree()
604
456
basis.lock_read()
605
# TODO: Consider re-evaluating the need for this with CHKInventory
606
# we don't strictly need to mutate an inventory for this
607
# it only makes sense when apply_delta is cheaper than get_inventory()
608
inventory = basis.inventory._get_mutable_inventory()
457
inventory = basis.inventory
610
459
inventory.apply_delta(delta)
611
rev_tree = revisiontree.RevisionTree(self.branch.repository,
612
inventory, new_revid)
460
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
613
461
self.set_parent_trees([(new_revid, rev_tree)])
616
class MutableTreeHooks(hooks.Hooks):
617
"""A dictionary mapping a hook name to a list of callables for mutabletree
622
"""Create the default hooks.
625
hooks.Hooks.__init__(self)
626
self.create_hook(hooks.HookPoint('start_commit',
627
"Called before a commit is performed on a tree. The start commit "
628
"hook is able to change the tree before the commit takes place. "
629
"start_commit is called with the bzrlib.mutabletree.MutableTree "
630
"that the commit is being performed on.", (1, 4), None))
631
self.create_hook(hooks.HookPoint('post_commit',
632
"Called after a commit is performed on a tree. The hook is "
633
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
634
"The mutable tree the commit was performed on is available via "
635
"the mutable_tree attribute of that object.", (2, 0), None))
638
# install the default hooks into the MutableTree class.
639
MutableTree.hooks = MutableTreeHooks()
642
class PostCommitHookParams(object):
643
"""Parameters for the post_commit hook.
645
To access the parameters, use the following attributes:
647
* mutable_tree - the MutableTree object
650
def __init__(self, mutable_tree):
651
"""Create the parameters for the post_commit hook."""
652
self.mutable_tree = mutable_tree
655
464
class _FastPath(object):
656
465
"""A path object with fast accessors for things like basename."""
693
502
# slower but does not need parent_ie
694
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
503
if inv.has_filename(path.raw_path):
696
505
# its really not there : add the parent
697
506
# note that the dirname use leads to some extra str copying etc but as
698
507
# there are a limited number of dirs we can be nested under, it should
699
508
# generally find it very fast and not recurse after that.
700
509
added = _add_one_and_parent(tree, inv, None,
701
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
702
parent_id = inv.path2id(osutils.dirname(path.raw_path))
510
_FastPath(dirname(path.raw_path)), 'directory', action)
511
parent_id = inv.path2id(dirname(path.raw_path))
703
512
parent_ie = inv[parent_id]
704
513
_add_one(tree, inv, parent_ie, path, kind, action)
705
514
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
