179
144
raise NotImplementedError(self._add)
146
@needs_tree_write_lock
181
147
def apply_inventory_delta(self, changes):
182
148
"""Apply changes to the inventory as an atomic operation.
184
:param changes: An inventory delta to apply to the working tree's
187
:seealso Inventory.apply_delta: For details on the changes parameter.
150
The argument is a set of changes to apply. It must describe a
151
valid result, but the order is not important. Specifically,
152
intermediate stages *may* be invalid, such as when two files
155
The changes should be structured as a list of tuples, of the form
156
(old_path, new_path, file_id, new_entry). For creation, old_path
157
must be None. For deletion, new_path and new_entry must be None.
158
file_id is always non-None. For renames and other mutations, all
159
values must be non-None.
161
If the new_entry is a directory, its children should be an empty
162
dict. Children are handled by apply_inventory_delta itself.
164
:param changes: A list of tuples for the change to apply:
165
[(old_path, new_path, file_id, new_inventory_entry), ...]
189
raise NotImplementedError(self.apply_inventory_delta)
170
for old_path, file_id in sorted(((op, f) for op, np, f, e in changes
171
if op is not None), reverse=True):
172
if file_id not in inv:
174
children[file_id] = getattr(inv[file_id], 'children', {})
175
inv.remove_recursive_id(file_id)
176
for new_path, new_entry in sorted((np, e) for op, np, f, e in
177
changes if np is not None):
178
if getattr(new_entry, 'children', None) is not None:
179
new_entry.children = children.get(new_entry.file_id, {})
181
self._write_inventory(inv)
191
183
@needs_write_lock
192
184
def commit(self, message=None, revprops=None, *args,
194
186
# avoid circular imports
195
187
from bzrlib import commit
196
possible_master_transports=[]
197
revprops = commit.Commit.update_revprops(
200
kwargs.pop('authors', None),
201
kwargs.pop('author', None),
202
kwargs.get('local', False),
203
possible_master_transports)
190
if not 'branch-nick' in revprops:
191
revprops['branch-nick'] = self.branch.nick
204
192
# args for wt.commit start at message from the Commit.commit method,
205
193
args = (message, ) + args
206
for hook in MutableTree.hooks['start_commit']:
208
194
committed_id = commit.Commit().commit(working_tree=self,
210
possible_master_transports=possible_master_transports,
212
post_hook_params = PostCommitHookParams(self)
213
for hook in MutableTree.hooks['post_commit']:
214
hook(post_hook_params)
195
revprops=revprops, *args, **kwargs)
215
196
return committed_id
217
198
def _gather_kinds(self, files, kinds):
367
255
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
368
256
"""Set the parents of the working tree.
370
:param parents_list: A list of (revision_id, tree) tuples.
258
:param parents_list: A list of (revision_id, tree) tuples.
371
259
If tree is None, then that element is treated as an unreachable
372
260
parent tree - i.e. a ghost.
374
262
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.
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
459
def update_basis_by_delta(self, new_revid, delta):
460
"""Update the parents of this tree after a commit.
462
This gives the tree one parent, with revision id new_revid. The
463
inventory delta is applied to the current basis tree to generate the
464
inventory for the parent new_revid, and all other parent trees are
467
All the changes in the delta should be changes synchronising the basis
468
tree with some or all of the working tree, with a change to a directory
469
requiring that its contents have been recursively included. That is,
470
this is not a general purpose tree modification routine, but a helper
471
for commit which is not required to handle situations that do not arise
474
See the inventory developers documentation for the theory behind
477
:param new_revid: The new revision id for the trees parent.
478
:param delta: An inventory delta (see apply_inventory_delta) describing
479
the changes from the current left most parent revision to new_revid.
481
# if the tree is updated by a pull to the branch, as happens in
482
# WorkingTree2, when there was no separation between branch and tree,
483
# then just clear merges, efficiency is not a concern for now as this
484
# is legacy environments only, and they are slow regardless.
485
if self.last_revision() == new_revid:
486
self.set_parent_ids([new_revid])
488
# generic implementation based on Inventory manipulation. See
489
# WorkingTree classes for optimised versions for specific format trees.
490
basis = self.basis_tree()
492
# TODO: Consider re-evaluating the need for this with CHKInventory
493
# we don't strictly need to mutate an inventory for this
494
# it only makes sense when apply_delta is cheaper than get_inventory()
495
inventory = _mod_inventory.mutable_inventory_from_tree(basis)
497
inventory.apply_delta(delta)
498
rev_tree = revisiontree.InventoryRevisionTree(self.branch.repository,
499
inventory, new_revid)
500
self.set_parent_trees([(new_revid, rev_tree)])
503
class MutableTreeHooks(hooks.Hooks):
504
"""A dictionary mapping a hook name to a list of callables for mutabletree
509
"""Create the default hooks.
512
hooks.Hooks.__init__(self, "bzrlib.mutabletree", "MutableTree.hooks")
513
self.add_hook('start_commit',
514
"Called before a commit is performed on a tree. The start commit "
515
"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))
525
# install the default hooks into the MutableTree class.
526
MutableTree.hooks = MutableTreeHooks()
529
class PostCommitHookParams(object):
530
"""Parameters for the post_commit hook.
532
To access the parameters, use the following attributes:
534
* mutable_tree - the MutableTree object
537
def __init__(self, mutable_tree):
538
"""Create the parameters for the post_commit hook."""
539
self.mutable_tree = mutable_tree
542
class _SmartAddHelper(object):
543
"""Helper for MutableTree.smart_add."""
545
def get_inventory_delta(self):
546
return self._invdelta.values()
548
def _get_ie(self, inv_path):
549
"""Retrieve the most up to date inventory entry for a path.
551
:param inv_path: Normalized inventory path
552
:return: Inventory entry (with possibly invalid .children for
555
entry = self._invdelta.get(inv_path)
556
if entry is not None:
558
# Find a 'best fit' match if the filesystem is case-insensitive
559
inv_path = self.tree._fix_case_of_inventory_path(inv_path)
560
file_id = self.tree.path2id(inv_path)
561
if file_id is not None:
562
return self.tree.iter_entries_by_dir([file_id]).next()[1]
565
def _convert_to_directory(self, this_ie, inv_path):
566
"""Convert an entry to a directory.
568
:param this_ie: Inventory entry
569
:param inv_path: Normalized path for the inventory entry
570
:return: The new inventory entry
572
# Same as in _add_one below, if the inventory doesn't
573
# think this is a directory, update the inventory
574
this_ie = _mod_inventory.InventoryDirectory(
575
this_ie.file_id, this_ie.name, this_ie.parent_id)
576
self._invdelta[inv_path] = (inv_path, inv_path, this_ie.file_id,
580
def _add_one_and_parent(self, parent_ie, path, kind, inv_path):
581
"""Add a new entry to the inventory and automatically add unversioned parents.
583
:param parent_ie: Parent inventory entry if known, or None. If
584
None, the parent is looked up by name and used if present, otherwise it
585
is recursively added.
587
:param kind: Kind of new entry (file, directory, etc)
589
:return: Inventory entry for path and a list of paths which have been added.
591
# Nothing to do if path is already versioned.
592
# This is safe from infinite recursion because the tree root is
594
inv_dirname = osutils.dirname(inv_path)
595
dirname, basename = osutils.split(path)
596
if parent_ie is None:
597
# slower but does not need parent_ie
598
this_ie = self._get_ie(inv_path)
599
if this_ie is not None:
601
# its really not there : add the parent
602
# note that the dirname use leads to some extra str copying etc but as
603
# there are a limited number of dirs we can be nested under, it should
604
# generally find it very fast and not recurse after that.
605
parent_ie = self._add_one_and_parent(None,
606
dirname, 'directory',
608
# if the parent exists, but isn't a directory, we have to do the
609
# kind change now -- really the inventory shouldn't pretend to know
610
# the kind of wt files, but it does.
611
if parent_ie.kind != 'directory':
612
# nb: this relies on someone else checking that the path we're using
613
# doesn't contain symlinks.
614
parent_ie = self._convert_to_directory(parent_ie, inv_dirname)
615
file_id = self.action(self.tree.inventory, parent_ie, path, kind)
616
entry = _mod_inventory.make_entry(kind, basename, parent_ie.file_id,
618
self._invdelta[inv_path] = (None, inv_path, entry.file_id, entry)
619
self.added.append(inv_path)
622
def _gather_dirs_to_add(self, user_dirs):
623
# only walk the minimal parents needed: we have user_dirs to override
627
is_inside = osutils.is_inside_or_parent_of_any
628
for path, (inv_path, this_ie) in sorted(
629
user_dirs.iteritems(), key=operator.itemgetter(0)):
630
if (prev_dir is None or not is_inside([prev_dir], path)):
631
yield (path, inv_path, this_ie, None)
634
def __init__(self, tree, action, conflicts_related=None):
637
self.action = add.AddAction()
643
if conflicts_related is None:
644
self.conflicts_related = frozenset()
646
self.conflicts_related = conflicts_related
648
def add(self, file_list, recurse=True):
649
from bzrlib.inventory import InventoryEntry
651
# no paths supplied: add the entire tree.
652
# FIXME: this assumes we are running in a working tree subdir :-/
656
# expand any symlinks in the directory part, while leaving the
658
# only expanding if symlinks are supported avoids windows path bugs
659
if osutils.has_symlinks():
660
file_list = map(osutils.normalizepath, file_list)
663
# validate user file paths and convert all paths to tree
664
# relative : it's cheaper to make a tree relative path an abspath
665
# than to convert an abspath to tree relative, and it's cheaper to
666
# perform the canonicalization in bulk.
667
for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
668
# validate user parameters. Our recursive code avoids adding new
669
# files that need such validation
670
if self.tree.is_control_filename(filepath):
671
raise errors.ForbiddenControlFileError(filename=filepath)
673
abspath = self.tree.abspath(filepath)
674
kind = osutils.file_kind(abspath)
675
# ensure the named path is added, so that ignore rules in the later
676
# directory walk dont skip it.
677
# we dont have a parent ie known yet.: use the relatively slower
678
# inventory probing method
679
inv_path, _ = osutils.normalized_filename(filepath)
680
this_ie = self._get_ie(inv_path)
682
this_ie = self._add_one_and_parent(None, filepath, kind, inv_path)
683
if kind == 'directory':
684
# schedule the dir for scanning
685
user_dirs[filepath] = (inv_path, this_ie)
688
# no need to walk any directories at all.
691
things_to_add = list(self._gather_dirs_to_add(user_dirs))
693
illegalpath_re = re.compile(r'[\r\n]')
694
for directory, inv_path, this_ie, parent_ie in things_to_add:
695
# directory is tree-relative
696
abspath = self.tree.abspath(directory)
698
# get the contents of this directory.
700
# find the kind of the path being added, and save stat_value
704
stat_value = osutils.file_stat(abspath)
705
kind = osutils.file_kind_from_stat_mode(stat_value.st_mode)
709
# allow AddAction to skip this file
710
if self.action.skip_file(self.tree, abspath, kind, stat_value):
712
if not InventoryEntry.versionable_kind(kind):
713
trace.warning("skipping %s (can't add file of kind '%s')",
716
if illegalpath_re.search(directory):
717
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
719
if directory in self.conflicts_related:
720
# If the file looks like one generated for a conflict, don't
723
'skipping %s (generated to help resolve conflicts)',
727
if kind == 'directory' and directory != '':
729
transport = _mod_transport.get_transport_from_path(abspath)
730
controldir.ControlDirFormat.find_format(transport)
732
except errors.NotBranchError:
734
except errors.UnsupportedFormatError:
739
if this_ie is not None:
742
# XXX: This is wrong; people *might* reasonably be trying to
743
# add subtrees as subtrees. This should probably only be done
744
# in formats which can represent subtrees, and even then
745
# perhaps only when the user asked to add subtrees. At the
746
# moment you can add them specially through 'join --reference',
747
# which is perhaps reasonable: adding a new reference is a
748
# special operation and can have a special behaviour. mbp
750
trace.warning("skipping nested tree %r", abspath)
752
this_ie = self._add_one_and_parent(parent_ie, directory, kind,
755
if kind == 'directory' and not sub_tree:
756
if this_ie.kind != 'directory':
757
this_ie = self._convert_to_directory(this_ie, inv_path)
759
for subf in sorted(os.listdir(abspath)):
760
inv_f, _ = osutils.normalized_filename(subf)
761
# here we could use TreeDirectory rather than
762
# string concatenation.
763
subp = osutils.pathjoin(directory, subf)
764
# TODO: is_control_filename is very slow. Make it faster.
765
# TreeDirectory.is_control_filename could also make this
766
# faster - its impossible for a non root dir to have a
768
if self.tree.is_control_filename(subp):
769
trace.mutter("skip control directory %r", subp)
771
sub_invp = osutils.pathjoin(inv_path, inv_f)
772
entry = self._invdelta.get(sub_invp)
773
if entry is not None:
776
sub_ie = this_ie.children.get(inv_f)
777
if sub_ie is not None:
778
# recurse into this already versioned subdir.
779
things_to_add.append((subp, sub_invp, sub_ie, this_ie))
781
# user selection overrides ignores
782
# ignore while selecting files - if we globbed in the
783
# outer loop we would ignore user files.
784
ignore_glob = self.tree.is_ignored(subp)
785
if ignore_glob is not None:
786
self.ignored.setdefault(ignore_glob, []).append(subp)
788
things_to_add.append((subp, sub_invp, None, this_ie))
added
removed
bzrlib/mutabletree.py
