410
393
of added files, and ignored_files is a dict mapping files that were
411
394
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")
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.
425
411
inv = self.inventory
430
conflicts_related = set()
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())
439
# validate user file paths and convert all paths to tree
440
# relative : it's cheaper to make a tree relative path an abspath
441
# than to convert an abspath to tree relative, and it's cheaper to
442
# perform the canonicalization in bulk.
443
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
444
rf = _FastPath(filepath)
445
# validate user parameters. Our recursive code avoids adding new
446
# files that need such validation
447
if self.is_control_filename(rf.raw_path):
448
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
450
abspath = self.abspath(rf.raw_path)
451
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
# ensure the named path is added, so that ignore rules in the later
459
# directory walk dont skip it.
460
# we dont have a parent ie known yet.: use the relatively slower
461
# inventory probing method
462
versioned = inv.has_filename(rf.raw_path)
465
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
468
# 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
483
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:
489
# directory is tree-relative
490
abspath = self.abspath(directory.raw_path)
492
# get the contents of this directory.
494
# find the kind of the path being added.
495
kind = osutils.file_kind(abspath)
497
if not InventoryEntry.versionable_kind(kind):
498
trace.warning("skipping %s (can't add file of kind '%s')",
501
if illegalpath_re.search(directory.raw_path):
502
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
504
if directory.raw_path in conflicts_related:
505
# If the file looks like one generated for a conflict, don't
508
'skipping %s (generated to help resolve conflicts)',
512
if parent_ie is not None:
513
versioned = directory.base_path in parent_ie.children
515
# without the parent ie, use the relatively slower inventory
517
versioned = inv.has_filename(
518
self._fix_case_of_inventory_path(directory.raw_path))
520
if kind == 'directory':
522
sub_branch = bzrdir.BzrDir.open(abspath)
524
except errors.NotBranchError:
526
except errors.UnsupportedFormatError:
531
if directory.raw_path == '':
532
# mutter("tree root doesn't need to be added")
536
# mutter("%r is already versioned", abspath)
538
# XXX: This is wrong; people *might* reasonably be trying to
539
# add subtrees as subtrees. This should probably only be done
540
# in formats which can represent subtrees, and even then
541
# perhaps only when the user asked to add subtrees. At the
542
# moment you can add them specially through 'join --reference',
543
# which is perhaps reasonable: adding a new reference is a
544
# special operation and can have a special behaviour. mbp
546
trace.mutter("%r is a nested bzr tree", abspath)
548
_add_one(self, inv, parent_ie, directory, kind, action)
549
added.append(directory.raw_path)
551
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]
565
for subf in sorted(os.listdir(abspath)):
566
# here we could use TreeDirectory rather than
567
# string concatenation.
568
subp = osutils.pathjoin(directory.raw_path, subf)
569
# TODO: is_control_filename is very slow. Make it faster.
570
# TreeDirectory.is_control_filename could also make this
571
# faster - its impossible for a non root dir to have a
573
if self.is_control_filename(subp):
574
trace.mutter("skip control directory %r", subp)
575
elif subf in this_ie.children:
576
# recurse into this already versioned subdir.
577
dirs_to_add.append((_FastPath(subp, subf), this_ie))
579
# user selection overrides ignoes
580
# ignore while selecting files - if we globbed in the
581
# outer loop we would ignore user files.
582
ignore_glob = self.is_ignored(subp)
583
if ignore_glob is not None:
584
# mutter("skip ignored sub-file %r", subp)
585
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
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
597
459
def update_basis_by_delta(self, new_revid, delta):
598
460
"""Update the parents of this tree after a commit.
677
542
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,
545
class _SmartAddHelper(object):
546
"""Helper for MutableTree.smart_add."""
548
def get_inventory_delta(self):
549
return self._invdelta.values()
551
def _get_ie(self, inv_path):
552
"""Retrieve the most up to date inventory entry for a path.
554
:param inv_path: Normalized inventory path
555
:return: Inventory entry (with possibly invalid .children for
558
entry = self._invdelta.get(inv_path)
559
if entry is not None:
561
# Find a 'best fit' match if the filesystem is case-insensitive
562
inv_path = self.tree._fix_case_of_inventory_path(inv_path)
563
file_id = self.tree.path2id(inv_path)
564
if file_id is not None:
565
return self.tree.iter_entries_by_dir([file_id]).next()[1]
568
def _convert_to_directory(self, this_ie, inv_path):
569
"""Convert an entry to a directory.
571
:param this_ie: Inventory entry
572
:param inv_path: Normalized path for the inventory entry
573
:return: The new inventory entry
575
# Same as in _add_one below, if the inventory doesn't
576
# think this is a directory, update the inventory
577
this_ie = _mod_inventory.InventoryDirectory(
578
this_ie.file_id, this_ie.name, this_ie.parent_id)
579
self._invdelta[inv_path] = (inv_path, inv_path, this_ie.file_id,
583
def _add_one_and_parent(self, parent_ie, path, kind, inv_path):
584
"""Add a new entry to the inventory and automatically add unversioned parents.
586
:param parent_ie: Parent inventory entry if known, or None. If
587
None, the parent is looked up by name and used if present, otherwise it
588
is recursively added.
590
:param kind: Kind of new entry (file, directory, etc)
592
:return: Inventory entry for path and a list of paths which have been added.
594
# Nothing to do if path is already versioned.
595
# This is safe from infinite recursion because the tree root is
597
inv_dirname = osutils.dirname(inv_path)
598
dirname, basename = osutils.split(path)
599
if parent_ie is None:
600
# slower but does not need parent_ie
601
this_ie = self._get_ie(inv_path)
602
if this_ie is not None:
604
# its really not there : add the parent
605
# note that the dirname use leads to some extra str copying etc but as
606
# there are a limited number of dirs we can be nested under, it should
607
# generally find it very fast and not recurse after that.
608
parent_ie = self._add_one_and_parent(None,
609
dirname, 'directory',
611
# if the parent exists, but isn't a directory, we have to do the
612
# kind change now -- really the inventory shouldn't pretend to know
613
# the kind of wt files, but it does.
614
if parent_ie.kind != 'directory':
615
# nb: this relies on someone else checking that the path we're using
616
# doesn't contain symlinks.
617
parent_ie = self._convert_to_directory(parent_ie, inv_dirname)
618
file_id = self.action(self.tree.inventory, parent_ie, path, kind)
619
entry = _mod_inventory.make_entry(kind, basename, parent_ie.file_id,
621
self._invdelta[inv_path] = (None, inv_path, entry.file_id, entry)
622
self.added.append(inv_path)
625
def _gather_dirs_to_add(self, user_dirs):
626
# only walk the minimal parents needed: we have user_dirs to override
630
is_inside = osutils.is_inside_or_parent_of_any
631
for path, (inv_path, this_ie) in sorted(
632
user_dirs.iteritems(), key=operator.itemgetter(0)):
633
if (prev_dir is None or not is_inside([prev_dir], path)):
634
yield (path, inv_path, this_ie, None)
637
def __init__(self, tree, action, conflicts_related=None):
640
self.action = add.AddAction()
646
if conflicts_related is None:
647
self.conflicts_related = frozenset()
649
self.conflicts_related = conflicts_related
651
def add(self, file_list, recurse=True):
652
from bzrlib.inventory import InventoryEntry
654
# no paths supplied: add the entire tree.
655
# FIXME: this assumes we are running in a working tree subdir :-/
659
# expand any symlinks in the directory part, while leaving the
661
# only expanding if symlinks are supported avoids windows path bugs
662
if osutils.has_symlinks():
663
file_list = map(osutils.normalizepath, file_list)
666
# validate user file paths and convert all paths to tree
667
# relative : it's cheaper to make a tree relative path an abspath
668
# than to convert an abspath to tree relative, and it's cheaper to
669
# perform the canonicalization in bulk.
670
for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
671
# validate user parameters. Our recursive code avoids adding new
672
# files that need such validation
673
if self.tree.is_control_filename(filepath):
674
raise errors.ForbiddenControlFileError(filename=filepath)
676
abspath = self.tree.abspath(filepath)
677
kind = osutils.file_kind(abspath)
678
# ensure the named path is added, so that ignore rules in the later
679
# directory walk dont skip it.
680
# we dont have a parent ie known yet.: use the relatively slower
681
# inventory probing method
682
inv_path, _ = osutils.normalized_filename(filepath)
683
this_ie = self._get_ie(inv_path)
685
this_ie = self._add_one_and_parent(None, filepath, kind, inv_path)
686
if kind == 'directory':
687
# schedule the dir for scanning
688
user_dirs[filepath] = (inv_path, this_ie)
691
# no need to walk any directories at all.
694
things_to_add = list(self._gather_dirs_to_add(user_dirs))
696
illegalpath_re = re.compile(r'[\r\n]')
697
for directory, inv_path, this_ie, parent_ie in things_to_add:
698
# directory is tree-relative
699
abspath = self.tree.abspath(directory)
701
# get the contents of this directory.
703
# find the kind of the path being added, and save stat_value
707
stat_value = osutils.file_stat(abspath)
708
kind = osutils.file_kind_from_stat_mode(stat_value.st_mode)
712
# allow AddAction to skip this file
713
if self.action.skip_file(self.tree, abspath, kind, stat_value):
715
if not InventoryEntry.versionable_kind(kind):
716
trace.warning("skipping %s (can't add file of kind '%s')",
719
if illegalpath_re.search(directory):
720
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
722
if directory in self.conflicts_related:
723
# If the file looks like one generated for a conflict, don't
726
'skipping %s (generated to help resolve conflicts)',
730
if kind == 'directory' and directory != '':
732
transport = _mod_transport.get_transport_from_path(abspath)
733
controldir.ControlDirFormat.find_format(transport)
735
except errors.NotBranchError:
737
except errors.UnsupportedFormatError:
742
if this_ie is not None:
745
# XXX: This is wrong; people *might* reasonably be trying to
746
# add subtrees as subtrees. This should probably only be done
747
# in formats which can represent subtrees, and even then
748
# perhaps only when the user asked to add subtrees. At the
749
# moment you can add them specially through 'join --reference',
750
# which is perhaps reasonable: adding a new reference is a
751
# special operation and can have a special behaviour. mbp
753
trace.warning("skipping nested tree %r", abspath)
755
this_ie = self._add_one_and_parent(parent_ie, directory, kind,
758
if kind == 'directory' and not sub_tree:
759
if this_ie.kind != 'directory':
760
this_ie = self._convert_to_directory(this_ie, inv_path)
762
for subf in sorted(os.listdir(abspath)):
763
inv_f, _ = osutils.normalized_filename(subf)
764
# here we could use TreeDirectory rather than
765
# string concatenation.
766
subp = osutils.pathjoin(directory, subf)
767
# TODO: is_control_filename is very slow. Make it faster.
768
# TreeDirectory.is_control_filename could also make this
769
# faster - its impossible for a non root dir to have a
771
if self.tree.is_control_filename(subp):
772
trace.mutter("skip control directory %r", subp)
774
sub_invp = osutils.pathjoin(inv_path, inv_f)
775
entry = self._invdelta.get(sub_invp)
776
if entry is not None:
779
sub_ie = this_ie.children.get(inv_f)
780
if sub_ie is not None:
781
# recurse into this already versioned subdir.
782
things_to_add.append((subp, sub_invp, sub_ie, this_ie))
784
# user selection overrides ignores
785
# ignore while selecting files - if we globbed in the
786
# outer loop we would ignore user files.
787
ignore_glob = self.tree.is_ignored(subp)
788
if ignore_glob is not None:
789
self.ignored.setdefault(ignore_glob, []).append(subp)
791
things_to_add.append((subp, sub_invp, None, this_ie))
added
removed
bzrlib/mutabletree.py
