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