374
348
raise NotImplementedError(self.set_parent_trees)
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.
442
# Not all mutable trees can have conflicts
443
if getattr(self, 'conflicts', None) is not None:
444
# Collect all related files without checking whether they exist or
445
# are versioned. It's cheaper to do that once for all conflicts
446
# than trying to find the relevant conflict for each added file.
447
conflicts_related = set()
448
for c in self.conflicts():
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
350
@needs_tree_write_lock
351
def smart_add(self, file_list, recurse=True, action=None, save=True):
352
"""Version file_list, optionally recursing into directories.
354
This is designed more towards DWIM for humans than API clarity.
355
For the specific behaviour see the help for cmd_add().
357
:param action: A reporter to be called with the inventory, parent_ie,
358
path and kind of the path being added. It may return a file_id if
359
a specific one should be used.
360
:param save: Save the inventory after completing the adds. If False
361
this provides dry-run functionality by doing the add and not saving
363
:return: A tuple - files_added, ignored_files. files_added is the count
364
of added files, and ignored_files is a dict mapping files that were
365
ignored to the rule that caused them to be ignored.
367
# not in an inner loop; and we want to remove direct use of this,
368
# so here as a reminder for now. RBC 20070703
369
from bzrlib.inventory import InventoryEntry
371
action = add.AddAction()
374
# no paths supplied: add the entire tree.
376
# mutter("smart add of %r")
383
# validate user file paths and convert all paths to tree
384
# relative : it's cheaper to make a tree relative path an abspath
385
# than to convert an abspath to tree relative, and it's cheaper to
386
# perform the canonicalization in bulk.
387
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
388
rf = _FastPath(filepath)
389
# validate user parameters. Our recursive code avoids adding new files
390
# that need such validation
391
if self.is_control_filename(rf.raw_path):
392
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
394
abspath = self.abspath(rf.raw_path)
395
kind = osutils.file_kind(abspath)
396
if kind == 'directory':
397
# schedule the dir for scanning
400
if not InventoryEntry.versionable_kind(kind):
401
raise errors.BadFileKindError(filename=abspath, kind=kind)
402
# ensure the named path is added, so that ignore rules in the later directory
404
# we dont have a parent ie known yet.: use the relatively slower inventory
406
versioned = inv.has_filename(rf.raw_path)
409
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
412
# no need to walk any directories at all.
413
if len(added) > 0 and save:
414
self._write_inventory(inv)
415
return added, ignored
417
# only walk the minimal parents needed: we have user_dirs to override
421
is_inside = osutils.is_inside_or_parent_of_any
422
for path in sorted(user_dirs):
423
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
424
dirs_to_add.append((path, None))
425
prev_dir = path.raw_path
427
# dirs_to_add is initialised to a list of directories, but as we scan
428
# directories we append files to it.
429
# XXX: We should determine kind of files when we scan them rather than
430
# adding to this list. RBC 20070703
431
for directory, parent_ie in dirs_to_add:
432
# directory is tree-relative
433
abspath = self.abspath(directory.raw_path)
435
# get the contents of this directory.
437
# find the kind of the path being added.
438
kind = osutils.file_kind(abspath)
440
if not InventoryEntry.versionable_kind(kind):
441
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
444
if parent_ie is not None:
445
versioned = directory.base_path in parent_ie.children
447
# without the parent ie, use the relatively slower inventory
449
versioned = inv.has_filename(
450
self._fix_case_of_inventory_path(directory.raw_path))
452
if kind == 'directory':
454
sub_branch = bzrdir.BzrDir.open(abspath)
456
except errors.NotBranchError:
458
except errors.UnsupportedFormatError:
463
if directory.raw_path == '':
464
# mutter("tree root doesn't need to be added")
468
# mutter("%r is already versioned", abspath)
470
# XXX: This is wrong; people *might* reasonably be trying to add
471
# subtrees as subtrees. This should probably only be done in formats
472
# which can represent subtrees, and even then perhaps only when
473
# the user asked to add subtrees. At the moment you can add them
474
# specially through 'join --reference', which is perhaps
475
# reasonable: adding a new reference is a special operation and
476
# can have a special behaviour. mbp 20070306
477
mutter("%r is a nested bzr tree", abspath)
479
_add_one(self, inv, parent_ie, directory, kind, action)
480
added.append(directory.raw_path)
482
if kind == 'directory' and not sub_tree:
483
if parent_ie is not None:
485
this_ie = parent_ie.children[directory.base_path]
487
# without the parent ie, use the relatively slower inventory
489
this_id = inv.path2id(
490
self._fix_case_of_inventory_path(directory.raw_path))
494
this_ie = inv[this_id]
496
for subf in sorted(os.listdir(abspath)):
497
# here we could use TreeDirectory rather than
498
# string concatenation.
499
subp = osutils.pathjoin(directory.raw_path, subf)
500
# TODO: is_control_filename is very slow. Make it faster.
501
# TreeDirectory.is_control_filename could also make this
502
# faster - its impossible for a non root dir to have a
504
if self.is_control_filename(subp):
505
mutter("skip control directory %r", subp)
506
elif subf in this_ie.children:
507
# recurse into this already versioned subdir.
508
dirs_to_add.append((_FastPath(subp, subf), this_ie))
510
# user selection overrides ignoes
511
# ignore while selecting files - if we globbed in the
512
# outer loop we would ignore user files.
513
ignore_glob = self.is_ignored(subp)
514
if ignore_glob is not None:
515
# mutter("skip ignored sub-file %r", subp)
516
ignored.setdefault(ignore_glob, []).append(subp)
518
#mutter("queue to add sub-file %r", subp)
519
dirs_to_add.append((_FastPath(subp, subf), this_ie))
523
self._write_inventory(inv)
525
self.read_working_inventory()
526
return added, ignored
459
528
def update_basis_by_delta(self, new_revid, delta):
460
529
"""Update the parents of this tree after a commit.
509
577
"""Create the default hooks.
512
hooks.Hooks.__init__(self, "bzrlib.mutabletree", "MutableTree.hooks")
513
self.add_hook('start_commit',
580
hooks.Hooks.__init__(self)
581
self.create_hook(hooks.HookPoint('start_commit',
514
582
"Called before a commit is performed on a tree. The start commit "
515
583
"hook is able to change the tree before the commit takes place. "
516
"start_commit is called with the bzrlib.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 bzrlib.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 "
584
"start_commit is called with the bzrlib.tree.MutableTree that the "
585
"commit is being performed on.", (1, 4), None))
536
588
# install the default hooks into the MutableTree class.
537
589
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
return self._invdelta.values()
559
def _get_ie(self, inv_path):
560
"""Retrieve the most up to date inventory entry for a path.
562
:param inv_path: Normalized inventory path
563
:return: Inventory entry (with possibly invalid .children for
566
entry = self._invdelta.get(inv_path)
567
if entry is not None:
569
# Find a 'best fit' match if the filesystem is case-insensitive
570
inv_path = self.tree._fix_case_of_inventory_path(inv_path)
571
file_id = self.tree.path2id(inv_path)
572
if file_id is not None:
573
return self.tree.iter_entries_by_dir([file_id]).next()[1]
576
def _convert_to_directory(self, this_ie, inv_path):
577
"""Convert an entry to a directory.
579
:param this_ie: Inventory entry
580
:param inv_path: Normalized path for the inventory entry
581
:return: The new inventory entry
583
# Same as in _add_one below, if the inventory doesn't
584
# think this is a directory, update the inventory
585
this_ie = _mod_inventory.InventoryDirectory(
586
this_ie.file_id, this_ie.name, this_ie.parent_id)
587
self._invdelta[inv_path] = (inv_path, inv_path, this_ie.file_id,
591
def _add_one_and_parent(self, parent_ie, path, kind, inv_path):
592
"""Add a new entry to the inventory and automatically add unversioned parents.
594
:param parent_ie: Parent inventory entry if known, or None. If
595
None, the parent is looked up by name and used if present, otherwise it
596
is recursively added.
598
:param kind: Kind of new entry (file, directory, etc)
600
:return: Inventory entry for path and a list of paths which have been added.
602
# Nothing to do if path is already versioned.
603
# This is safe from infinite recursion because the tree root is
605
inv_dirname = osutils.dirname(inv_path)
606
dirname, basename = osutils.split(path)
607
if parent_ie is None:
608
# slower but does not need parent_ie
609
this_ie = self._get_ie(inv_path)
610
if this_ie is not None:
612
# its really not there : add the parent
613
# note that the dirname use leads to some extra str copying etc but as
614
# there are a limited number of dirs we can be nested under, it should
615
# generally find it very fast and not recurse after that.
616
parent_ie = self._add_one_and_parent(None,
617
dirname, 'directory',
619
# if the parent exists, but isn't a directory, we have to do the
620
# kind change now -- really the inventory shouldn't pretend to know
621
# the kind of wt files, but it does.
622
if parent_ie.kind != 'directory':
623
# nb: this relies on someone else checking that the path we're using
624
# doesn't contain symlinks.
625
parent_ie = self._convert_to_directory(parent_ie, inv_dirname)
626
file_id = self.action(self.tree, parent_ie, path, kind)
627
entry = _mod_inventory.make_entry(kind, basename, parent_ie.file_id,
629
self._invdelta[inv_path] = (None, inv_path, entry.file_id, entry)
630
self.added.append(inv_path)
633
def _gather_dirs_to_add(self, user_dirs):
634
# only walk the minimal parents needed: we have user_dirs to override
638
is_inside = osutils.is_inside_or_parent_of_any
639
for path, (inv_path, this_ie) in sorted(
640
user_dirs.iteritems(), key=operator.itemgetter(0)):
641
if (prev_dir is None or not is_inside([prev_dir], path)):
642
yield (path, inv_path, this_ie, None)
645
def __init__(self, tree, action, conflicts_related=None):
648
self.action = add.AddAction()
654
if conflicts_related is None:
655
self.conflicts_related = frozenset()
657
self.conflicts_related = conflicts_related
659
def add(self, file_list, recurse=True):
660
from bzrlib.inventory import InventoryEntry
662
# no paths supplied: add the entire tree.
663
# FIXME: this assumes we are running in a working tree subdir :-/
667
# expand any symlinks in the directory part, while leaving the
669
# only expanding if symlinks are supported avoids windows path bugs
670
if osutils.has_symlinks():
671
file_list = map(osutils.normalizepath, file_list)
674
# validate user file paths and convert all paths to tree
675
# relative : it's cheaper to make a tree relative path an abspath
676
# than to convert an abspath to tree relative, and it's cheaper to
677
# perform the canonicalization in bulk.
678
for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
679
# validate user parameters. Our recursive code avoids adding new
680
# files that need such validation
681
if self.tree.is_control_filename(filepath):
682
raise errors.ForbiddenControlFileError(filename=filepath)
684
abspath = self.tree.abspath(filepath)
685
kind = osutils.file_kind(abspath)
686
# ensure the named path is added, so that ignore rules in the later
687
# directory walk dont skip it.
688
# we dont have a parent ie known yet.: use the relatively slower
689
# inventory probing method
690
inv_path, _ = osutils.normalized_filename(filepath)
691
this_ie = self._get_ie(inv_path)
693
this_ie = self._add_one_and_parent(None, filepath, kind, inv_path)
694
if kind == 'directory':
695
# schedule the dir for scanning
696
user_dirs[filepath] = (inv_path, this_ie)
699
# no need to walk any directories at all.
702
things_to_add = list(self._gather_dirs_to_add(user_dirs))
704
illegalpath_re = re.compile(r'[\r\n]')
705
for directory, inv_path, this_ie, parent_ie in things_to_add:
706
# directory is tree-relative
707
abspath = self.tree.abspath(directory)
709
# get the contents of this directory.
711
# find the kind of the path being added, and save stat_value
715
stat_value = osutils.file_stat(abspath)
716
kind = osutils.file_kind_from_stat_mode(stat_value.st_mode)
720
# allow AddAction to skip this file
721
if self.action.skip_file(self.tree, abspath, kind, stat_value):
723
if not InventoryEntry.versionable_kind(kind):
724
trace.warning("skipping %s (can't add file of kind '%s')",
727
if illegalpath_re.search(directory):
728
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
730
if directory in self.conflicts_related:
731
# If the file looks like one generated for a conflict, don't
734
'skipping %s (generated to help resolve conflicts)',
738
if kind == 'directory' and directory != '':
740
transport = _mod_transport.get_transport_from_path(abspath)
741
controldir.ControlDirFormat.find_format(transport)
743
except errors.NotBranchError:
745
except errors.UnsupportedFormatError:
750
if this_ie is not None:
753
# XXX: This is wrong; people *might* reasonably be trying to
754
# add subtrees as subtrees. This should probably only be done
755
# in formats which can represent subtrees, and even then
756
# perhaps only when the user asked to add subtrees. At the
757
# moment you can add them specially through 'join --reference',
758
# which is perhaps reasonable: adding a new reference is a
759
# special operation and can have a special behaviour. mbp
761
trace.warning("skipping nested tree %r", abspath)
763
this_ie = self._add_one_and_parent(parent_ie, directory, kind,
766
if kind == 'directory' and not sub_tree:
767
if this_ie.kind != 'directory':
768
this_ie = self._convert_to_directory(this_ie, inv_path)
770
for subf in sorted(os.listdir(abspath)):
771
inv_f, _ = osutils.normalized_filename(subf)
772
# here we could use TreeDirectory rather than
773
# string concatenation.
774
subp = osutils.pathjoin(directory, subf)
775
# TODO: is_control_filename is very slow. Make it faster.
776
# TreeDirectory.is_control_filename could also make this
777
# faster - its impossible for a non root dir to have a
779
if self.tree.is_control_filename(subp):
780
trace.mutter("skip control directory %r", subp)
782
sub_invp = osutils.pathjoin(inv_path, inv_f)
783
entry = self._invdelta.get(sub_invp)
784
if entry is not None:
787
sub_ie = this_ie.children.get(inv_f)
788
if sub_ie is not None:
789
# recurse into this already versioned subdir.
790
things_to_add.append((subp, sub_invp, sub_ie, this_ie))
792
# user selection overrides ignores
793
# ignore while selecting files - if we globbed in the
794
# outer loop we would ignore user files.
795
ignore_glob = self.tree.is_ignored(subp)
796
if ignore_glob is not None:
797
self.ignored.setdefault(ignore_glob, []).append(subp)
799
things_to_add.append((subp, sub_invp, None, this_ie))
592
class _FastPath(object):
593
"""A path object with fast accessors for things like basename."""
595
__slots__ = ['raw_path', 'base_path']
597
def __init__(self, path, base_path=None):
598
"""Construct a FastPath from path."""
599
if base_path is None:
600
self.base_path = osutils.basename(path)
602
self.base_path = base_path
605
def __cmp__(self, other):
606
return cmp(self.raw_path, other.raw_path)
609
return hash(self.raw_path)
612
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
613
"""Add a new entry to the inventory and automatically add unversioned parents.
615
:param inv: Inventory which will receive the new entry.
616
:param parent_ie: Parent inventory entry if known, or None. If
617
None, the parent is looked up by name and used if present, otherwise it
618
is recursively added.
619
:param kind: Kind of new entry (file, directory, etc)
620
:param action: callback(inv, parent_ie, path, kind); return ignored.
621
:return: A list of paths which have been added.
623
# Nothing to do if path is already versioned.
624
# This is safe from infinite recursion because the tree root is
626
if parent_ie is not None:
627
# we have a parent ie already
630
# slower but does not need parent_ie
631
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
633
# its really not there : add the parent
634
# note that the dirname use leads to some extra str copying etc but as
635
# there are a limited number of dirs we can be nested under, it should
636
# generally find it very fast and not recurse after that.
637
added = _add_one_and_parent(tree, inv, None,
638
_FastPath(dirname(path.raw_path)), 'directory', action)
639
parent_id = inv.path2id(dirname(path.raw_path))
640
parent_ie = inv[parent_id]
641
_add_one(tree, inv, parent_ie, path, kind, action)
642
return added + [path.raw_path]
645
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
646
"""Add a new entry to the inventory.
648
:param inv: Inventory which will receive the new entry.
649
:param parent_ie: Parent inventory entry.
650
:param kind: Kind of new entry (file, directory, etc)
651
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
652
file_id or None to generate a new file id
655
file_id = file_id_callback(inv, parent_ie, path, kind)
656
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
