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