377
394
raise NotImplementedError(self.set_parent_trees)
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.
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()
445
431
# Not all mutable trees can have conflicts
446
432
if getattr(self, 'conflicts', None) is not None:
447
433
# Collect all related files without checking whether they exist or
448
434
# are versioned. It's cheaper to do that once for all conflicts
449
435
# than trying to find the relevant conflict for each added file.
450
conflicts_related = set()
451
436
for c in self.conflicts():
452
437
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
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
462
597
def update_basis_by_delta(self, new_revid, delta):
463
598
"""Update the parents of this tree after a commit.
553
677
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))
679
# validate user file paths and convert all paths to tree
680
# relative : it's cheaper to make a tree relative path an abspath
681
# than to convert an abspath to tree relative, and it's cheaper to
682
# perform the canonicalization in bulk.
683
for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
684
# validate user parameters. Our recursive code avoids adding new
685
# files that need such validation
686
if self.tree.is_control_filename(filepath):
687
raise errors.ForbiddenControlFileError(filename=filepath)
689
abspath = self.tree.abspath(filepath)
690
kind = osutils.file_kind(abspath)
691
# ensure the named path is added, so that ignore rules in the later
692
# directory walk dont skip it.
693
# we dont have a parent ie known yet.: use the relatively slower
694
# inventory probing method
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)
704
# no need to walk any directories at all.
707
things_to_add = list(self._gather_dirs_to_add(user_dirs))
709
illegalpath_re = re.compile(r'[\r\n]')
710
for directory, inv_path, this_ie, parent_ie in things_to_add:
711
# directory is tree-relative
712
abspath = self.tree.abspath(directory)
714
# get the contents of this directory.
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):
728
if not InventoryEntry.versionable_kind(kind):
729
trace.warning("skipping %s (can't add file of kind '%s')",
732
if illegalpath_re.search(directory):
733
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
735
if directory in self.conflicts_related:
736
# If the file looks like one generated for a conflict, don't
739
'skipping %s (generated to help resolve conflicts)',
743
if kind == 'directory' and directory != '':
745
transport = _mod_transport.get_transport_from_path(abspath)
746
controldir.ControlDirFormat.find_format(transport)
748
except errors.NotBranchError:
750
except errors.UnsupportedFormatError:
755
if this_ie is not None:
758
# XXX: This is wrong; people *might* reasonably be trying to
759
# add subtrees as subtrees. This should probably only be done
760
# in formats which can represent subtrees, and even then
761
# perhaps only when the user asked to add subtrees. At the
762
# moment you can add them specially through 'join --reference',
763
# which is perhaps reasonable: adding a new reference is a
764
# special operation and can have a special behaviour. mbp
766
trace.warning("skipping nested tree %r", abspath)
768
this_ie = self._add_one_and_parent(parent_ie, directory, kind,
771
if kind == 'directory' and not sub_tree:
772
if this_ie.kind != 'directory':
773
this_ie = self._convert_to_directory(this_ie, inv_path)
775
for subf in sorted(os.listdir(abspath)):
776
inv_f, _ = osutils.normalized_filename(subf)
777
# here we could use TreeDirectory rather than
778
# string concatenation.
779
subp = osutils.pathjoin(directory, subf)
780
# TODO: is_control_filename is very slow. Make it faster.
781
# TreeDirectory.is_control_filename could also make this
782
# faster - its impossible for a non root dir to have a
784
if self.tree.is_control_filename(subp):
785
trace.mutter("skip control directory %r", subp)
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:
794
# recurse into this already versioned subdir.
795
things_to_add.append((subp, sub_invp, sub_ie, this_ie))
797
# user selection overrides ignores
798
# ignore while selecting files - if we globbed in the
799
# outer loop we would ignore user files.
800
ignore_glob = self.tree.is_ignored(subp)
801
if ignore_glob is not None:
802
self.ignored.setdefault(ignore_glob, []).append(subp)
804
things_to_add.append((subp, sub_invp, None, this_ie))
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,
added
removed
bzrlib/mutabletree.py
