120
143
kinds = [None] * len(files)
121
144
elif not len(kinds) == len(files):
122
145
raise AssertionError()
123
with self.lock_tree_write():
125
# generic constraint checks:
126
if self.is_control_filename(f):
127
raise errors.ForbiddenControlFileError(filename=f)
128
fp = osutils.splitpath(f)
129
# fill out file kinds for all files [not needed when we stop
130
# caring about the instantaneous file kind within a uncommmitted tree
132
self._gather_kinds(files, kinds)
133
self._add(files, ids, kinds)
147
# generic constraint checks:
148
if self.is_control_filename(f):
149
raise errors.ForbiddenControlFileError(filename=f)
150
fp = osutils.splitpath(f)
151
# fill out file kinds for all files [not needed when we stop
152
# caring about the instantaneous file kind within a uncommmitted tree
154
self._gather_kinds(files, kinds)
155
self._add(files, ids, kinds)
135
157
def add_reference(self, sub_tree):
136
"""Add a TreeReference to the tree, pointing at sub_tree.
138
:param sub_tree: subtree to add.
158
"""Add a TreeReference to the tree, pointing at sub_tree"""
140
159
raise errors.UnsupportedOperation(self.add_reference, self)
161
def _add_reference(self, sub_tree):
162
"""Standard add_reference implementation, for use by subclasses"""
164
sub_tree_path = self.relpath(sub_tree.basedir)
165
except errors.PathNotChild:
166
raise errors.BadReferenceTarget(self, sub_tree,
167
'Target not inside tree.')
168
sub_tree_id = sub_tree.get_root_id()
169
if sub_tree_id == self.get_root_id():
170
raise errors.BadReferenceTarget(self, sub_tree,
171
'Trees have the same root id.')
172
if self.has_id(sub_tree_id):
173
raise errors.BadReferenceTarget(self, sub_tree,
174
'Root id already present in tree')
175
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
142
177
def _add(self, files, ids, kinds):
143
178
"""Helper function for add - updates the inventory.
150
185
raise NotImplementedError(self._add)
187
def apply_inventory_delta(self, changes):
188
"""Apply changes to the inventory as an atomic operation.
190
:param changes: An inventory delta to apply to the working tree's
193
:seealso Inventory.apply_delta: For details on the changes parameter.
195
raise NotImplementedError(self.apply_inventory_delta)
152
198
def commit(self, message=None, revprops=None, *args, **kwargs):
153
199
# avoid circular imports
154
200
from breezy import commit
155
possible_master_transports = []
156
with self.lock_write():
157
revprops = commit.Commit.update_revprops(
201
possible_master_transports=[]
202
revprops = commit.Commit.update_revprops(
160
205
kwargs.pop('authors', None),
161
206
kwargs.get('local', False),
162
207
possible_master_transports)
163
# args for wt.commit start at message from the Commit.commit method,
164
args = (message, ) + args
165
for hook in MutableTree.hooks['start_commit']:
167
committed_id = commit.Commit().commit(working_tree=self,
169
possible_master_transports=possible_master_transports,
171
post_hook_params = PostCommitHookParams(self)
172
for hook in MutableTree.hooks['post_commit']:
173
hook(post_hook_params)
208
# args for wt.commit start at message from the Commit.commit method,
209
args = (message, ) + args
210
for hook in MutableTree.hooks['start_commit']:
212
committed_id = commit.Commit().commit(working_tree=self,
214
possible_master_transports=possible_master_transports,
216
post_hook_params = PostCommitHookParams(self)
217
for hook in MutableTree.hooks['post_commit']:
218
hook(post_hook_params)
176
221
def _gather_kinds(self, files, kinds):
177
222
"""Helper function for add - sets the entries of kinds."""
178
223
raise NotImplementedError(self._gather_kinds)
180
226
def has_changes(self, _from_tree=None):
181
227
"""Quickly check that the tree contains at least one commitable change.
353
382
This is designed more towards DWIM for humans than API clarity.
354
383
For the specific behaviour see the help for cmd_add().
356
:param file_list: List of zero or more paths. *NB: these are
357
interpreted relative to the process cwd, not relative to the
385
:param file_list: List of zero or more paths. *NB: these are
386
interpreted relative to the process cwd, not relative to the
358
387
tree.* (Add and most other tree methods use tree-relative
360
:param action: A reporter to be called with the working tree, parent_ie,
389
:param action: A reporter to be called with the inventory, parent_ie,
361
390
path and kind of the path being added. It may return a file_id if
362
391
a specific one should be used.
363
:param save: Save the changes after completing the adds. If False
392
:param save: Save the inventory after completing the adds. If False
364
393
this provides dry-run functionality by doing the add and not saving
366
395
:return: A tuple - files_added, ignored_files. files_added is the count
367
396
of added files, and ignored_files is a dict mapping files that were
368
397
ignored to the rule that caused them to be ignored.
370
399
raise NotImplementedError(self.smart_add)
372
def rename_one(self, from_rel, to_rel, after=False):
375
This can change the directory or the filename or both.
377
rename_one has several 'modes' to work. First, it can rename a physical
378
file and change the file_id. That is the normal mode. Second, it can
379
only change the file_id without touching any physical file.
381
rename_one uses the second mode if 'after == True' and 'to_rel' is
382
either not versioned or newly added, and present in the working tree.
384
rename_one uses the second mode if 'after == False' and 'from_rel' is
385
versioned but no longer in the working tree, and 'to_rel' is not
386
versioned but present in the working tree.
388
rename_one uses the first mode if 'after == False' and 'from_rel' is
389
versioned and present in the working tree, and 'to_rel' is not
390
versioned and not present in the working tree.
392
Everything else results in an error.
394
raise NotImplementedError(self.rename_one)
396
def copy_one(self, from_rel, to_rel):
397
"""Copy one file or directory.
399
This can change the directory or the filename or both.
402
raise NotImplementedError(self.copy_one)
404
def transform(self, pb=None):
405
"""Return a transform object for use with this tree."""
406
raise NotImplementedError(self.transform)
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.
445
# Not all mutable trees can have conflicts
446
if getattr(self, 'conflicts', None) is not None:
447
# Collect all related files without checking whether they exist or
448
# are versioned. It's cheaper to do that once for all conflicts
449
# than trying to find the relevant conflict for each added file.
450
conflicts_related = set()
451
for c in self.conflicts():
452
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
462
def update_basis_by_delta(self, new_revid, delta):
463
"""Update the parents of this tree after a commit.
465
This gives the tree one parent, with revision id new_revid. The
466
inventory delta is applied to the current basis tree to generate the
467
inventory for the parent new_revid, and all other parent trees are
470
All the changes in the delta should be changes synchronising the basis
471
tree with some or all of the working tree, with a change to a directory
472
requiring that its contents have been recursively included. That is,
473
this is not a general purpose tree modification routine, but a helper
474
for commit which is not required to handle situations that do not arise
477
See the inventory developers documentation for the theory behind
480
:param new_revid: The new revision id for the trees parent.
481
:param delta: An inventory delta (see apply_inventory_delta) describing
482
the changes from the current left most parent revision to new_revid.
484
# if the tree is updated by a pull to the branch, as happens in
485
# WorkingTree2, when there was no separation between branch and tree,
486
# then just clear merges, efficiency is not a concern for now as this
487
# is legacy environments only, and they are slow regardless.
488
if self.last_revision() == new_revid:
489
self.set_parent_ids([new_revid])
491
# generic implementation based on Inventory manipulation. See
492
# WorkingTree classes for optimised versions for specific format trees.
493
basis = self.basis_tree()
495
# TODO: Consider re-evaluating the need for this with CHKInventory
496
# we don't strictly need to mutate an inventory for this
497
# it only makes sense when apply_delta is cheaper than get_inventory()
498
inventory = _mod_inventory.mutable_inventory_from_tree(basis)
500
inventory.apply_delta(delta)
501
rev_tree = revisiontree.InventoryRevisionTree(self.branch.repository,
502
inventory, new_revid)
503
self.set_parent_trees([(new_revid, rev_tree)])
409
506
class MutableTreeHooks(hooks.Hooks):
418
515
hooks.Hooks.__init__(self, "breezy.mutabletree", "MutableTree.hooks")
419
516
self.add_hook('start_commit',
420
"Called before a commit is performed on a tree. The start commit "
421
"hook is able to change the tree before the commit takes place. "
422
"start_commit is called with the breezy.mutabletree.MutableTree "
423
"that the commit is being performed on.", (1, 4))
517
"Called before a commit is performed on a tree. The start commit "
518
"hook is able to change the tree before the commit takes place. "
519
"start_commit is called with the breezy.mutabletree.MutableTree "
520
"that the commit is being performed on.", (1, 4))
424
521
self.add_hook('post_commit',
425
"Called after a commit is performed on a tree. The hook is "
426
"called with a breezy.mutabletree.PostCommitHookParams object. "
427
"The mutable tree the commit was performed on is available via "
428
"the mutable_tree attribute of that object.", (2, 0))
522
"Called after a commit is performed on a tree. The hook is "
523
"called with a breezy.mutabletree.PostCommitHookParams object. "
524
"The mutable tree the commit was performed on is available via "
525
"the mutable_tree attribute of that object.", (2, 0))
429
526
self.add_hook('pre_transform',
430
"Called before a tree transform on this tree. The hook is called "
431
"with the tree that is being transformed and the transform.",
527
"Called before a tree transform on this tree. The hook is called "
528
"with the tree that is being transformed and the transform.",
433
530
self.add_hook('post_build_tree',
434
"Called after a completely new tree is built. The hook is "
435
"called with the tree as its only argument.", (2, 5))
531
"Called after a completely new tree is built. The hook is "
532
"called with the tree as its only argument.", (2, 5))
436
533
self.add_hook('post_transform',
437
"Called after a tree transform has been performed on a tree. "
438
"The hook is called with the tree that is being transformed and "
534
"Called after a tree transform has been performed on a tree. "
535
"The hook is called with the tree that is being transformed and "
443
539
# install the default hooks into the MutableTree class.
444
540
MutableTree.hooks = MutableTreeHooks()
455
551
def __init__(self, mutable_tree):
456
552
"""Create the parameters for the post_commit hook."""
457
553
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))
added
removed
breezy/mutabletree.py
