394
374
raise NotImplementedError(self.set_parent_trees)
396
@needs_tree_write_lock
397
def smart_add(self, file_list, recurse=True, action=None, save=True):
398
"""Version file_list, optionally recursing into directories.
400
This is designed more towards DWIM for humans than API clarity.
401
For the specific behaviour see the help for cmd_add().
403
:param action: A reporter to be called with the inventory, parent_ie,
404
path and kind of the path being added. It may return a file_id if
405
a specific one should be used.
406
:param save: Save the inventory after completing the adds. If False
407
this provides dry-run functionality by doing the add and not saving
409
:return: A tuple - files_added, ignored_files. files_added is the count
410
of added files, and ignored_files is a dict mapping files that were
411
ignored to the rule that caused them to be ignored.
413
# not in an inner loop; and we want to remove direct use of this,
414
# so here as a reminder for now. RBC 20070703
415
from bzrlib.inventory import InventoryEntry
417
action = add.AddAction()
420
# no paths supplied: add the entire tree.
421
# FIXME: this assumes we are running in a working tree subdir :-/
424
# mutter("smart add of %r")
430
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.
431
442
# Not all mutable trees can have conflicts
432
443
if getattr(self, 'conflicts', None) is not None:
433
444
# Collect all related files without checking whether they exist or
434
445
# are versioned. It's cheaper to do that once for all conflicts
435
446
# than trying to find the relevant conflict for each added file.
447
conflicts_related = set()
436
448
for c in self.conflicts():
437
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, "breezy.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 breezy.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 breezy.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
# GZ 2016-06-05: Returning view would probably be fine but currently
558
# Inventory.apply_delta is documented as requiring a list of changes.
559
return list(viewvalues(self._invdelta))
561
def _get_ie(self, inv_path):
562
"""Retrieve the most up to date inventory entry for a path.
564
:param inv_path: Normalized inventory path
565
:return: Inventory entry (with possibly invalid .children for
568
entry = self._invdelta.get(inv_path)
569
if entry is not None:
571
# Find a 'best fit' match if the filesystem is case-insensitive
572
inv_path = self.tree._fix_case_of_inventory_path(inv_path)
573
file_id = self.tree.path2id(inv_path)
574
if file_id is not None:
575
return self.tree.iter_entries_by_dir([file_id]).next()[1]
578
def _convert_to_directory(self, this_ie, inv_path):
579
"""Convert an entry to a directory.
581
:param this_ie: Inventory entry
582
:param inv_path: Normalized path for the inventory entry
583
:return: The new inventory entry
585
# Same as in _add_one below, if the inventory doesn't
586
# think this is a directory, update the inventory
587
this_ie = _mod_inventory.InventoryDirectory(
588
this_ie.file_id, this_ie.name, this_ie.parent_id)
589
self._invdelta[inv_path] = (inv_path, inv_path, this_ie.file_id,
593
def _add_one_and_parent(self, parent_ie, path, kind, inv_path):
594
"""Add a new entry to the inventory and automatically add unversioned parents.
596
:param parent_ie: Parent inventory entry if known, or None. If
597
None, the parent is looked up by name and used if present, otherwise it
598
is recursively added.
600
:param kind: Kind of new entry (file, directory, etc)
602
:return: Inventory entry for path and a list of paths which have been added.
604
# Nothing to do if path is already versioned.
605
# This is safe from infinite recursion because the tree root is
607
inv_dirname = osutils.dirname(inv_path)
608
dirname, basename = osutils.split(path)
609
if parent_ie is None:
610
# slower but does not need parent_ie
611
this_ie = self._get_ie(inv_path)
612
if this_ie is not None:
614
# its really not there : add the parent
615
# note that the dirname use leads to some extra str copying etc but as
616
# there are a limited number of dirs we can be nested under, it should
617
# generally find it very fast and not recurse after that.
618
parent_ie = self._add_one_and_parent(None,
619
dirname, 'directory',
621
# if the parent exists, but isn't a directory, we have to do the
622
# kind change now -- really the inventory shouldn't pretend to know
623
# the kind of wt files, but it does.
624
if parent_ie.kind != 'directory':
625
# nb: this relies on someone else checking that the path we're using
626
# doesn't contain symlinks.
627
parent_ie = self._convert_to_directory(parent_ie, inv_dirname)
628
file_id = self.action(self.tree, parent_ie, path, kind)
629
entry = _mod_inventory.make_entry(kind, basename, parent_ie.file_id,
631
self._invdelta[inv_path] = (None, inv_path, entry.file_id, entry)
632
self.added.append(inv_path)
635
def _gather_dirs_to_add(self, user_dirs):
636
# only walk the minimal parents needed: we have user_dirs to override
640
is_inside = osutils.is_inside_or_parent_of_any
641
for path in sorted(user_dirs):
642
if (prev_dir is None or not is_inside([prev_dir], path)):
643
inv_path, this_ie = user_dirs[path]
644
yield (path, inv_path, this_ie, None)
647
def __init__(self, tree, action, conflicts_related=None):
650
self.action = add.AddAction()
656
if conflicts_related is None:
657
self.conflicts_related = frozenset()
659
self.conflicts_related = conflicts_related
661
def add(self, file_list, recurse=True):
662
from breezy.inventory import InventoryEntry
664
# no paths supplied: add the entire tree.
665
# FIXME: this assumes we are running in a working tree subdir :-/
669
# expand any symlinks in the directory part, while leaving the
671
# only expanding if symlinks are supported avoids windows path bugs
672
if osutils.has_symlinks():
673
file_list = list(map(osutils.normalizepath, file_list))
439
676
# validate user file paths and convert all paths to tree
440
677
# relative : it's cheaper to make a tree relative path an abspath
441
678
# than to convert an abspath to tree relative, and it's cheaper to
442
679
# perform the canonicalization in bulk.
443
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
444
rf = _FastPath(filepath)
680
for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
445
681
# validate user parameters. Our recursive code avoids adding new
446
682
# files that need such validation
447
if self.is_control_filename(rf.raw_path):
448
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
683
if self.tree.is_control_filename(filepath):
684
raise errors.ForbiddenControlFileError(filename=filepath)
450
abspath = self.abspath(rf.raw_path)
686
abspath = self.tree.abspath(filepath)
451
687
kind = osutils.file_kind(abspath)
452
if kind == 'directory':
453
# schedule the dir for scanning
456
if not InventoryEntry.versionable_kind(kind):
457
raise errors.BadFileKindError(filename=abspath, kind=kind)
458
688
# ensure the named path is added, so that ignore rules in the later
459
689
# directory walk dont skip it.
460
690
# we dont have a parent ie known yet.: use the relatively slower
461
691
# inventory probing method
462
versioned = inv.has_filename(rf.raw_path)
465
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
692
inv_path, _ = osutils.normalized_filename(filepath)
693
this_ie = self._get_ie(inv_path)
695
this_ie = self._add_one_and_parent(None, filepath, kind, inv_path)
696
if kind == 'directory':
697
# schedule the dir for scanning
698
user_dirs[filepath] = (inv_path, this_ie)
468
701
# no need to walk any directories at all.
469
if len(added) > 0 and save:
470
self._write_inventory(inv)
471
return added, ignored
473
# only walk the minimal parents needed: we have user_dirs to override
477
is_inside = osutils.is_inside_or_parent_of_any
478
for path in sorted(user_dirs):
479
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
480
dirs_to_add.append((path, None))
481
prev_dir = path.raw_path
704
things_to_add = list(self._gather_dirs_to_add(user_dirs))
483
706
illegalpath_re = re.compile(r'[\r\n]')
484
# dirs_to_add is initialised to a list of directories, but as we scan
485
# directories we append files to it.
486
# XXX: We should determine kind of files when we scan them rather than
487
# adding to this list. RBC 20070703
488
for directory, parent_ie in dirs_to_add:
707
for directory, inv_path, this_ie, parent_ie in things_to_add:
489
708
# directory is tree-relative
490
abspath = self.abspath(directory.raw_path)
709
abspath = self.tree.abspath(directory)
492
711
# get the contents of this directory.
494
# find the kind of the path being added.
495
kind = osutils.file_kind(abspath)
713
# find the kind of the path being added, and save stat_value
717
stat_value = osutils.file_stat(abspath)
718
kind = osutils.file_kind_from_stat_mode(stat_value.st_mode)
722
# allow AddAction to skip this file
723
if self.action.skip_file(self.tree, abspath, kind, stat_value):
497
725
if not InventoryEntry.versionable_kind(kind):
498
726
trace.warning("skipping %s (can't add file of kind '%s')",
501
if illegalpath_re.search(directory.raw_path):
729
if illegalpath_re.search(directory):
502
730
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
504
if directory.raw_path in conflicts_related:
732
if directory in self.conflicts_related:
505
733
# If the file looks like one generated for a conflict, don't
543
760
# which is perhaps reasonable: adding a new reference is a
544
761
# special operation and can have a special behaviour. mbp
546
trace.mutter("%r is a nested bzr tree", abspath)
763
trace.warning("skipping nested tree %r", abspath)
548
_add_one(self, inv, parent_ie, directory, kind, action)
549
added.append(directory.raw_path)
765
this_ie = self._add_one_and_parent(parent_ie, directory, kind,
551
768
if kind == 'directory' and not sub_tree:
552
if parent_ie is not None:
554
this_ie = parent_ie.children[directory.base_path]
556
# without the parent ie, use the relatively slower inventory
558
this_id = inv.path2id(
559
self._fix_case_of_inventory_path(directory.raw_path))
563
this_ie = inv[this_id]
769
if this_ie.kind != 'directory':
770
this_ie = self._convert_to_directory(this_ie, inv_path)
565
772
for subf in sorted(os.listdir(abspath)):
773
inv_f, _ = osutils.normalized_filename(subf)
566
774
# here we could use TreeDirectory rather than
567
775
# string concatenation.
568
subp = osutils.pathjoin(directory.raw_path, subf)
776
subp = osutils.pathjoin(directory, subf)
569
777
# TODO: is_control_filename is very slow. Make it faster.
570
778
# TreeDirectory.is_control_filename could also make this
571
779
# faster - its impossible for a non root dir to have a
573
if self.is_control_filename(subp):
781
if self.tree.is_control_filename(subp):
574
782
trace.mutter("skip control directory %r", subp)
575
elif subf in this_ie.children:
784
sub_invp = osutils.pathjoin(inv_path, inv_f)
785
entry = self._invdelta.get(sub_invp)
786
if entry is not None:
789
sub_ie = this_ie.children.get(inv_f)
790
if sub_ie is not None:
576
791
# recurse into this already versioned subdir.
577
dirs_to_add.append((_FastPath(subp, subf), this_ie))
792
things_to_add.append((subp, sub_invp, sub_ie, this_ie))
579
# user selection overrides ignoes
794
# user selection overrides ignores
580
795
# ignore while selecting files - if we globbed in the
581
796
# outer loop we would ignore user files.
582
ignore_glob = self.is_ignored(subp)
797
ignore_glob = self.tree.is_ignored(subp)
583
798
if ignore_glob is not None:
584
# mutter("skip ignored sub-file %r", subp)
585
ignored.setdefault(ignore_glob, []).append(subp)
799
self.ignored.setdefault(ignore_glob, []).append(subp)
587
#mutter("queue to add sub-file %r", subp)
588
dirs_to_add.append((_FastPath(subp, subf), this_ie))
592
self._write_inventory(inv)
594
self.read_working_inventory()
595
return added, ignored
597
def update_basis_by_delta(self, new_revid, delta):
598
"""Update the parents of this tree after a commit.
600
This gives the tree one parent, with revision id new_revid. The
601
inventory delta is applied to the current basis tree to generate the
602
inventory for the parent new_revid, and all other parent trees are
605
All the changes in the delta should be changes synchronising the basis
606
tree with some or all of the working tree, with a change to a directory
607
requiring that its contents have been recursively included. That is,
608
this is not a general purpose tree modification routine, but a helper
609
for commit which is not required to handle situations that do not arise
612
See the inventory developers documentation for the theory behind
615
:param new_revid: The new revision id for the trees parent.
616
:param delta: An inventory delta (see apply_inventory_delta) describing
617
the changes from the current left most parent revision to new_revid.
619
# if the tree is updated by a pull to the branch, as happens in
620
# WorkingTree2, when there was no separation between branch and tree,
621
# then just clear merges, efficiency is not a concern for now as this
622
# is legacy environments only, and they are slow regardless.
623
if self.last_revision() == new_revid:
624
self.set_parent_ids([new_revid])
626
# generic implementation based on Inventory manipulation. See
627
# WorkingTree classes for optimised versions for specific format trees.
628
basis = self.basis_tree()
630
# TODO: Consider re-evaluating the need for this with CHKInventory
631
# we don't strictly need to mutate an inventory for this
632
# it only makes sense when apply_delta is cheaper than get_inventory()
633
inventory = basis.inventory._get_mutable_inventory()
635
inventory.apply_delta(delta)
636
rev_tree = revisiontree.RevisionTree(self.branch.repository,
637
inventory, new_revid)
638
self.set_parent_trees([(new_revid, rev_tree)])
641
class MutableTreeHooks(hooks.Hooks):
642
"""A dictionary mapping a hook name to a list of callables for mutabletree
647
"""Create the default hooks.
650
hooks.Hooks.__init__(self)
651
self.create_hook(hooks.HookPoint('start_commit',
652
"Called before a commit is performed on a tree. The start commit "
653
"hook is able to change the tree before the commit takes place. "
654
"start_commit is called with the bzrlib.mutabletree.MutableTree "
655
"that the commit is being performed on.", (1, 4), None))
656
self.create_hook(hooks.HookPoint('post_commit',
657
"Called after a commit is performed on a tree. The hook is "
658
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
659
"The mutable tree the commit was performed on is available via "
660
"the mutable_tree attribute of that object.", (2, 0), None))
663
# install the default hooks into the MutableTree class.
664
MutableTree.hooks = MutableTreeHooks()
667
class PostCommitHookParams(object):
668
"""Parameters for the post_commit hook.
670
To access the parameters, use the following attributes:
672
* mutable_tree - the MutableTree object
675
def __init__(self, mutable_tree):
676
"""Create the parameters for the post_commit hook."""
677
self.mutable_tree = mutable_tree
680
class _FastPath(object):
681
"""A path object with fast accessors for things like basename."""
683
__slots__ = ['raw_path', 'base_path']
685
def __init__(self, path, base_path=None):
686
"""Construct a FastPath from path."""
687
if base_path is None:
688
self.base_path = osutils.basename(path)
690
self.base_path = base_path
693
def __cmp__(self, other):
694
return cmp(self.raw_path, other.raw_path)
697
return hash(self.raw_path)
700
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
701
"""Add a new entry to the inventory and automatically add unversioned parents.
703
:param inv: Inventory which will receive the new entry.
704
:param parent_ie: Parent inventory entry if known, or None. If
705
None, the parent is looked up by name and used if present, otherwise it
706
is recursively added.
707
:param kind: Kind of new entry (file, directory, etc)
708
:param action: callback(inv, parent_ie, path, kind); return ignored.
709
:return: A list of paths which have been added.
711
# Nothing to do if path is already versioned.
712
# This is safe from infinite recursion because the tree root is
714
if parent_ie is not None:
715
# we have a parent ie already
718
# slower but does not need parent_ie
719
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
721
# its really not there : add the parent
722
# note that the dirname use leads to some extra str copying etc but as
723
# there are a limited number of dirs we can be nested under, it should
724
# generally find it very fast and not recurse after that.
725
added = _add_one_and_parent(tree, inv, None,
726
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
727
parent_id = inv.path2id(osutils.dirname(path.raw_path))
728
parent_ie = inv[parent_id]
729
_add_one(tree, inv, parent_ie, path, kind, action)
730
return added + [path.raw_path]
733
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
734
"""Add a new entry to the inventory.
736
:param inv: Inventory which will receive the new entry.
737
:param parent_ie: Parent inventory entry.
738
:param kind: Kind of new entry (file, directory, etc)
739
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
740
file_id or None to generate a new file id
743
file_id = file_id_callback(inv, parent_ie, path, kind)
744
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
801
things_to_add.append((subp, sub_invp, None, this_ie))
added
removed
breezy/mutabletree.py
