370
374
raise NotImplementedError(self.set_parent_trees)
372
@needs_tree_write_lock
373
def smart_add(self, file_list, recurse=True, action=None, save=True):
374
"""Version file_list, optionally recursing into directories.
376
This is designed more towards DWIM for humans than API clarity.
377
For the specific behaviour see the help for cmd_add().
379
:param file_list: List of zero or more paths. *NB: these are
380
interpreted relative to the process cwd, not relative to the
381
tree.* (Add and most other tree methods use tree-relative
383
:param action: A reporter to be called with the inventory, parent_ie,
384
path and kind of the path being added. It may return a file_id if
385
a specific one should be used.
386
:param save: Save the inventory after completing the adds. If False
387
this provides dry-run functionality by doing the add and not saving
389
:return: A tuple - files_added, ignored_files. files_added is the count
390
of added files, and ignored_files is a dict mapping files that were
391
ignored to the rule that caused them to be ignored.
393
# not in an inner loop; and we want to remove direct use of this,
394
# so here as a reminder for now. RBC 20070703
395
from bzrlib.inventory import InventoryEntry
397
action = add.AddAction()
400
# no paths supplied: add the entire tree.
401
# FIXME: this assumes we are running in a working tree subdir :-/
404
# mutter("smart add of %r")
410
conflicts_related = set()
376
def smart_add(self, file_list, recurse=True, action=None, save=True):
377
"""Version file_list, optionally recursing into directories.
379
This is designed more towards DWIM for humans than API clarity.
380
For the specific behaviour see the help for cmd_add().
382
:param file_list: List of zero or more paths. *NB: these are
383
interpreted relative to the process cwd, not relative to the
384
tree.* (Add and most other tree methods use tree-relative
386
:param action: A reporter to be called with the inventory, parent_ie,
387
path and kind of the path being added. It may return a file_id if
388
a specific one should be used.
389
:param save: Save the inventory after completing the adds. If False
390
this provides dry-run functionality by doing the add and not saving
392
:return: A tuple - files_added, ignored_files. files_added is the count
393
of added files, and ignored_files is a dict mapping files that were
394
ignored to the rule that caused them to be ignored.
396
raise NotImplementedError(self.smart_add)
399
class MutableInventoryTree(MutableTree, tree.InventoryTree):
401
@needs_tree_write_lock
402
def apply_inventory_delta(self, changes):
403
"""Apply changes to the inventory as an atomic operation.
405
:param changes: An inventory delta to apply to the working tree's
408
:seealso Inventory.apply_delta: For details on the changes parameter.
411
inv = self.root_inventory
412
inv.apply_delta(changes)
413
self._write_inventory(inv)
415
def _fix_case_of_inventory_path(self, path):
416
"""If our tree isn't case sensitive, return the canonical path"""
417
if not self.case_sensitive:
418
path = self.get_canonical_inventory_path(path)
421
@needs_tree_write_lock
422
def smart_add(self, file_list, recurse=True, action=None, save=True):
423
"""Version file_list, optionally recursing into directories.
425
This is designed more towards DWIM for humans than API clarity.
426
For the specific behaviour see the help for cmd_add().
428
:param file_list: List of zero or more paths. *NB: these are
429
interpreted relative to the process cwd, not relative to the
430
tree.* (Add and most other tree methods use tree-relative
432
:param action: A reporter to be called with the inventory, parent_ie,
433
path and kind of the path being added. It may return a file_id if
434
a specific one should be used.
435
:param save: Save the inventory after completing the adds. If False
436
this provides dry-run functionality by doing the add and not saving
438
:return: A tuple - files_added, ignored_files. files_added is the count
439
of added files, and ignored_files is a dict mapping files that were
440
ignored to the rule that caused them to be ignored.
411
442
# Not all mutable trees can have conflicts
412
443
if getattr(self, 'conflicts', None) is not None:
413
444
# Collect all related files without checking whether they exist or
414
445
# are versioned. It's cheaper to do that once for all conflicts
415
446
# than trying to find the relevant conflict for each added file.
447
conflicts_related = set()
416
448
for c in self.conflicts():
417
449
conflicts_related.update(c.associated_filenames())
451
conflicts_related = None
452
adder = _SmartAddHelper(self, action, conflicts_related)
453
adder.add(file_list, recurse=recurse)
455
invdelta = adder.get_inventory_delta()
456
self.apply_inventory_delta(invdelta)
457
return adder.added, adder.ignored
459
def update_basis_by_delta(self, new_revid, delta):
460
"""Update the parents of this tree after a commit.
462
This gives the tree one parent, with revision id new_revid. The
463
inventory delta is applied to the current basis tree to generate the
464
inventory for the parent new_revid, and all other parent trees are
467
All the changes in the delta should be changes synchronising the basis
468
tree with some or all of the working tree, with a change to a directory
469
requiring that its contents have been recursively included. That is,
470
this is not a general purpose tree modification routine, but a helper
471
for commit which is not required to handle situations that do not arise
474
See the inventory developers documentation for the theory behind
477
:param new_revid: The new revision id for the trees parent.
478
:param delta: An inventory delta (see apply_inventory_delta) describing
479
the changes from the current left most parent revision to new_revid.
481
# if the tree is updated by a pull to the branch, as happens in
482
# WorkingTree2, when there was no separation between branch and tree,
483
# then just clear merges, efficiency is not a concern for now as this
484
# is legacy environments only, and they are slow regardless.
485
if self.last_revision() == new_revid:
486
self.set_parent_ids([new_revid])
488
# generic implementation based on Inventory manipulation. See
489
# WorkingTree classes for optimised versions for specific format trees.
490
basis = self.basis_tree()
492
# TODO: Consider re-evaluating the need for this with CHKInventory
493
# we don't strictly need to mutate an inventory for this
494
# it only makes sense when apply_delta is cheaper than get_inventory()
495
inventory = _mod_inventory.mutable_inventory_from_tree(basis)
497
inventory.apply_delta(delta)
498
rev_tree = revisiontree.InventoryRevisionTree(self.branch.repository,
499
inventory, new_revid)
500
self.set_parent_trees([(new_revid, rev_tree)])
503
class MutableTreeHooks(hooks.Hooks):
504
"""A dictionary mapping a hook name to a list of callables for mutabletree
509
"""Create the default hooks.
512
hooks.Hooks.__init__(self, "bzrlib.mutabletree", "MutableTree.hooks")
513
self.add_hook('start_commit',
514
"Called before a commit is performed on a tree. The start commit "
515
"hook is able to change the tree before the commit takes place. "
516
"start_commit is called with the bzrlib.mutabletree.MutableTree "
517
"that the commit is being performed on.", (1, 4))
518
self.add_hook('post_commit',
519
"Called after a commit is performed on a tree. The hook is "
520
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
521
"The mutable tree the commit was performed on is available via "
522
"the mutable_tree attribute of that object.", (2, 0))
523
self.add_hook('pre_transform',
524
"Called before a tree transform on this tree. The hook is called "
525
"with the tree that is being transformed and the transform.",
527
self.add_hook('post_build_tree',
528
"Called after a completely new tree is built. The hook is "
529
"called with the tree as its only argument.", (2, 5))
530
self.add_hook('post_transform',
531
"Called after a tree transform has been performed on a tree. "
532
"The hook is called with the tree that is being transformed and "
536
# install the default hooks into the MutableTree class.
537
MutableTree.hooks = MutableTreeHooks()
540
class PostCommitHookParams(object):
541
"""Parameters for the post_commit hook.
543
To access the parameters, use the following attributes:
545
* mutable_tree - the MutableTree object
548
def __init__(self, mutable_tree):
549
"""Create the parameters for the post_commit hook."""
550
self.mutable_tree = mutable_tree
553
class _SmartAddHelper(object):
554
"""Helper for MutableTree.smart_add."""
556
def get_inventory_delta(self):
557
return self._invdelta.values()
559
def _get_ie(self, inv_path):
560
"""Retrieve the most up to date inventory entry for a path.
562
:param inv_path: Normalized inventory path
563
:return: Inventory entry (with possibly invalid .children for
566
entry = self._invdelta.get(inv_path)
567
if entry is not None:
569
# Find a 'best fit' match if the filesystem is case-insensitive
570
inv_path = self.tree._fix_case_of_inventory_path(inv_path)
571
file_id = self.tree.path2id(inv_path)
572
if file_id is not None:
573
return self.tree.iter_entries_by_dir([file_id]).next()[1]
576
def _convert_to_directory(self, this_ie, inv_path):
577
"""Convert an entry to a directory.
579
:param this_ie: Inventory entry
580
:param inv_path: Normalized path for the inventory entry
581
:return: The new inventory entry
583
# Same as in _add_one below, if the inventory doesn't
584
# think this is a directory, update the inventory
585
this_ie = _mod_inventory.InventoryDirectory(
586
this_ie.file_id, this_ie.name, this_ie.parent_id)
587
self._invdelta[inv_path] = (inv_path, inv_path, this_ie.file_id,
591
def _add_one_and_parent(self, parent_ie, path, kind, inv_path):
592
"""Add a new entry to the inventory and automatically add unversioned parents.
594
:param parent_ie: Parent inventory entry if known, or None. If
595
None, the parent is looked up by name and used if present, otherwise it
596
is recursively added.
598
:param kind: Kind of new entry (file, directory, etc)
600
:return: Inventory entry for path and a list of paths which have been added.
602
# Nothing to do if path is already versioned.
603
# This is safe from infinite recursion because the tree root is
605
inv_dirname = osutils.dirname(inv_path)
606
dirname, basename = osutils.split(path)
607
if parent_ie is None:
608
# slower but does not need parent_ie
609
this_ie = self._get_ie(inv_path)
610
if this_ie is not None:
612
# its really not there : add the parent
613
# note that the dirname use leads to some extra str copying etc but as
614
# there are a limited number of dirs we can be nested under, it should
615
# generally find it very fast and not recurse after that.
616
parent_ie = self._add_one_and_parent(None,
617
dirname, 'directory',
619
# if the parent exists, but isn't a directory, we have to do the
620
# kind change now -- really the inventory shouldn't pretend to know
621
# the kind of wt files, but it does.
622
if parent_ie.kind != 'directory':
623
# nb: this relies on someone else checking that the path we're using
624
# doesn't contain symlinks.
625
parent_ie = self._convert_to_directory(parent_ie, inv_dirname)
626
file_id = self.action(self.tree, parent_ie, path, kind)
627
entry = _mod_inventory.make_entry(kind, basename, parent_ie.file_id,
629
self._invdelta[inv_path] = (None, inv_path, entry.file_id, entry)
630
self.added.append(inv_path)
633
def _gather_dirs_to_add(self, user_dirs):
634
# only walk the minimal parents needed: we have user_dirs to override
638
is_inside = osutils.is_inside_or_parent_of_any
639
for path, (inv_path, this_ie) in sorted(
640
user_dirs.iteritems(), key=operator.itemgetter(0)):
641
if (prev_dir is None or not is_inside([prev_dir], path)):
642
yield (path, inv_path, this_ie, None)
645
def __init__(self, tree, action, conflicts_related=None):
648
self.action = add.AddAction()
654
if conflicts_related is None:
655
self.conflicts_related = frozenset()
657
self.conflicts_related = conflicts_related
659
def add(self, file_list, recurse=True):
660
from bzrlib.inventory import InventoryEntry
662
# no paths supplied: add the entire tree.
663
# FIXME: this assumes we are running in a working tree subdir :-/
419
667
# expand any symlinks in the directory part, while leaving the
421
file_list = map(osutils.normalizepath, file_list)
669
# only expanding if symlinks are supported avoids windows path bugs
670
if osutils.has_symlinks():
671
file_list = map(osutils.normalizepath, file_list)
423
674
# validate user file paths and convert all paths to tree
424
675
# relative : it's cheaper to make a tree relative path an abspath
425
676
# than to convert an abspath to tree relative, and it's cheaper to
426
677
# perform the canonicalization in bulk.
427
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
428
rf = _FastPath(filepath)
678
for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
429
679
# validate user parameters. Our recursive code avoids adding new
430
680
# files that need such validation
431
if self.is_control_filename(rf.raw_path):
432
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
681
if self.tree.is_control_filename(filepath):
682
raise errors.ForbiddenControlFileError(filename=filepath)
434
abspath = self.abspath(rf.raw_path)
684
abspath = self.tree.abspath(filepath)
435
685
kind = osutils.file_kind(abspath)
436
if kind == 'directory':
437
# schedule the dir for scanning
440
if not InventoryEntry.versionable_kind(kind):
441
raise errors.BadFileKindError(filename=abspath, kind=kind)
442
686
# ensure the named path is added, so that ignore rules in the later
443
687
# directory walk dont skip it.
444
688
# we dont have a parent ie known yet.: use the relatively slower
445
689
# inventory probing method
446
versioned = inv.has_filename(rf.raw_path)
449
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
690
inv_path, _ = osutils.normalized_filename(filepath)
691
this_ie = self._get_ie(inv_path)
693
this_ie = self._add_one_and_parent(None, filepath, kind, inv_path)
694
if kind == 'directory':
695
# schedule the dir for scanning
696
user_dirs[filepath] = (inv_path, this_ie)
452
699
# no need to walk any directories at all.
453
if len(added) > 0 and save:
454
self._write_inventory(inv)
455
return added, ignored
457
# only walk the minimal parents needed: we have user_dirs to override
461
is_inside = osutils.is_inside_or_parent_of_any
462
for path in sorted(user_dirs):
463
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
464
dirs_to_add.append((path, None))
465
prev_dir = path.raw_path
702
things_to_add = list(self._gather_dirs_to_add(user_dirs))
467
704
illegalpath_re = re.compile(r'[\r\n]')
468
# dirs_to_add is initialised to a list of directories, but as we scan
469
# directories we append files to it.
470
# XXX: We should determine kind of files when we scan them rather than
471
# adding to this list. RBC 20070703
472
for directory, parent_ie in dirs_to_add:
705
for directory, inv_path, this_ie, parent_ie in things_to_add:
473
706
# directory is tree-relative
474
abspath = self.abspath(directory.raw_path)
707
abspath = self.tree.abspath(directory)
476
709
# get the contents of this directory.
478
# find the kind of the path being added.
479
kind = osutils.file_kind(abspath)
711
# find the kind of the path being added, and save stat_value
715
stat_value = osutils.file_stat(abspath)
716
kind = osutils.file_kind_from_stat_mode(stat_value.st_mode)
720
# allow AddAction to skip this file
721
if self.action.skip_file(self.tree, abspath, kind, stat_value):
481
723
if not InventoryEntry.versionable_kind(kind):
482
724
trace.warning("skipping %s (can't add file of kind '%s')",
485
if illegalpath_re.search(directory.raw_path):
727
if illegalpath_re.search(directory):
486
728
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
488
if directory.raw_path in conflicts_related:
730
if directory in self.conflicts_related:
489
731
# If the file looks like one generated for a conflict, don't
527
758
# which is perhaps reasonable: adding a new reference is a
528
759
# special operation and can have a special behaviour. mbp
530
trace.mutter("%r is a nested bzr tree", abspath)
761
trace.warning("skipping nested tree %r", abspath)
532
_add_one(self, inv, parent_ie, directory, kind, action)
533
added.append(directory.raw_path)
763
this_ie = self._add_one_and_parent(parent_ie, directory, kind,
535
766
if kind == 'directory' and not sub_tree:
536
if parent_ie is not None:
538
this_ie = parent_ie.children[directory.base_path]
540
# without the parent ie, use the relatively slower inventory
542
this_id = inv.path2id(
543
self._fix_case_of_inventory_path(directory.raw_path))
547
this_ie = inv[this_id]
767
if this_ie.kind != 'directory':
768
this_ie = self._convert_to_directory(this_ie, inv_path)
549
770
for subf in sorted(os.listdir(abspath)):
771
inv_f, _ = osutils.normalized_filename(subf)
550
772
# here we could use TreeDirectory rather than
551
773
# string concatenation.
552
subp = osutils.pathjoin(directory.raw_path, subf)
774
subp = osutils.pathjoin(directory, subf)
553
775
# TODO: is_control_filename is very slow. Make it faster.
554
776
# TreeDirectory.is_control_filename could also make this
555
777
# faster - its impossible for a non root dir to have a
557
if self.is_control_filename(subp):
779
if self.tree.is_control_filename(subp):
558
780
trace.mutter("skip control directory %r", subp)
559
elif subf in this_ie.children:
782
sub_invp = osutils.pathjoin(inv_path, inv_f)
783
entry = self._invdelta.get(sub_invp)
784
if entry is not None:
787
sub_ie = this_ie.children.get(inv_f)
788
if sub_ie is not None:
560
789
# recurse into this already versioned subdir.
561
dirs_to_add.append((_FastPath(subp, subf), this_ie))
790
things_to_add.append((subp, sub_invp, sub_ie, this_ie))
563
# user selection overrides ignoes
792
# user selection overrides ignores
564
793
# ignore while selecting files - if we globbed in the
565
794
# outer loop we would ignore user files.
566
ignore_glob = self.is_ignored(subp)
795
ignore_glob = self.tree.is_ignored(subp)
567
796
if ignore_glob is not None:
568
# mutter("skip ignored sub-file %r", subp)
569
ignored.setdefault(ignore_glob, []).append(subp)
797
self.ignored.setdefault(ignore_glob, []).append(subp)
571
#mutter("queue to add sub-file %r", subp)
572
dirs_to_add.append((_FastPath(subp, subf), this_ie))
576
self._write_inventory(inv)
578
self.read_working_inventory()
579
return added, ignored
581
def update_basis_by_delta(self, new_revid, delta):
582
"""Update the parents of this tree after a commit.
584
This gives the tree one parent, with revision id new_revid. The
585
inventory delta is applied to the current basis tree to generate the
586
inventory for the parent new_revid, and all other parent trees are
589
All the changes in the delta should be changes synchronising the basis
590
tree with some or all of the working tree, with a change to a directory
591
requiring that its contents have been recursively included. That is,
592
this is not a general purpose tree modification routine, but a helper
593
for commit which is not required to handle situations that do not arise
596
See the inventory developers documentation for the theory behind
599
:param new_revid: The new revision id for the trees parent.
600
:param delta: An inventory delta (see apply_inventory_delta) describing
601
the changes from the current left most parent revision to new_revid.
603
# if the tree is updated by a pull to the branch, as happens in
604
# WorkingTree2, when there was no separation between branch and tree,
605
# then just clear merges, efficiency is not a concern for now as this
606
# is legacy environments only, and they are slow regardless.
607
if self.last_revision() == new_revid:
608
self.set_parent_ids([new_revid])
610
# generic implementation based on Inventory manipulation. See
611
# WorkingTree classes for optimised versions for specific format trees.
612
basis = self.basis_tree()
614
# TODO: Consider re-evaluating the need for this with CHKInventory
615
# we don't strictly need to mutate an inventory for this
616
# it only makes sense when apply_delta is cheaper than get_inventory()
617
inventory = basis.inventory._get_mutable_inventory()
619
inventory.apply_delta(delta)
620
rev_tree = revisiontree.RevisionTree(self.branch.repository,
621
inventory, new_revid)
622
self.set_parent_trees([(new_revid, rev_tree)])
625
class MutableTreeHooks(hooks.Hooks):
626
"""A dictionary mapping a hook name to a list of callables for mutabletree
631
"""Create the default hooks.
634
hooks.Hooks.__init__(self)
635
self.create_hook(hooks.HookPoint('start_commit',
636
"Called before a commit is performed on a tree. The start commit "
637
"hook is able to change the tree before the commit takes place. "
638
"start_commit is called with the bzrlib.mutabletree.MutableTree "
639
"that the commit is being performed on.", (1, 4), None))
640
self.create_hook(hooks.HookPoint('post_commit',
641
"Called after a commit is performed on a tree. The hook is "
642
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
643
"The mutable tree the commit was performed on is available via "
644
"the mutable_tree attribute of that object.", (2, 0), None))
647
# install the default hooks into the MutableTree class.
648
MutableTree.hooks = MutableTreeHooks()
651
class PostCommitHookParams(object):
652
"""Parameters for the post_commit hook.
654
To access the parameters, use the following attributes:
656
* mutable_tree - the MutableTree object
659
def __init__(self, mutable_tree):
660
"""Create the parameters for the post_commit hook."""
661
self.mutable_tree = mutable_tree
664
class _FastPath(object):
665
"""A path object with fast accessors for things like basename."""
667
__slots__ = ['raw_path', 'base_path']
669
def __init__(self, path, base_path=None):
670
"""Construct a FastPath from path."""
671
if base_path is None:
672
self.base_path = osutils.basename(path)
674
self.base_path = base_path
677
def __cmp__(self, other):
678
return cmp(self.raw_path, other.raw_path)
681
return hash(self.raw_path)
684
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
685
"""Add a new entry to the inventory and automatically add unversioned parents.
687
:param inv: Inventory which will receive the new entry.
688
:param parent_ie: Parent inventory entry if known, or None. If
689
None, the parent is looked up by name and used if present, otherwise it
690
is recursively added.
691
:param kind: Kind of new entry (file, directory, etc)
692
:param action: callback(inv, parent_ie, path, kind); return ignored.
693
:return: A list of paths which have been added.
695
# Nothing to do if path is already versioned.
696
# This is safe from infinite recursion because the tree root is
698
if parent_ie is not None:
699
# we have a parent ie already
702
# slower but does not need parent_ie
703
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
705
# its really not there : add the parent
706
# note that the dirname use leads to some extra str copying etc but as
707
# there are a limited number of dirs we can be nested under, it should
708
# generally find it very fast and not recurse after that.
709
added = _add_one_and_parent(tree, inv, None,
710
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
711
parent_id = inv.path2id(osutils.dirname(path.raw_path))
712
parent_ie = inv[parent_id]
713
_add_one(tree, inv, parent_ie, path, kind, action)
714
return added + [path.raw_path]
717
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
718
"""Add a new entry to the inventory.
720
:param inv: Inventory which will receive the new entry.
721
:param parent_ie: Parent inventory entry.
722
:param kind: Kind of new entry (file, directory, etc)
723
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
724
file_id or None to generate a new file id
727
# if the parent exists, but isn't a directory, we have to do the
728
# kind change now -- really the inventory shouldn't pretend to know
729
# the kind of wt files, but it does.
730
if parent_ie.kind != 'directory':
731
# nb: this relies on someone else checking that the path we're using
732
# doesn't contain symlinks.
733
new_parent_ie = inventory.make_entry('directory', parent_ie.name,
734
parent_ie.parent_id, parent_ie.file_id)
735
del inv[parent_ie.file_id]
736
inv.add(new_parent_ie)
737
parent_ie = new_parent_ie
738
file_id = file_id_callback(inv, parent_ie, path, kind)
739
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
799
things_to_add.append((subp, sub_invp, None, this_ie))
added
removed
bzrlib/mutabletree.py
