156
179
raise NotImplementedError(self._add)
158
@needs_tree_write_lock
159
181
def apply_inventory_delta(self, changes):
160
182
"""Apply changes to the inventory as an atomic operation.
162
The argument is a set of changes to apply. It must describe a
163
valid result, but the order is not important. Specifically,
164
intermediate stages *may* be invalid, such as when two files
167
The changes should be structured as a list of tuples, of the form
168
(old_path, new_path, file_id, new_entry). For creation, old_path
169
must be None. For deletion, new_path and new_entry must be None.
170
file_id is always non-None. For renames and other mutations, all
171
values must be non-None.
173
If the new_entry is a directory, its children should be an empty
174
dict. Children are handled by apply_inventory_delta itself.
176
:param changes: A list of tuples for the change to apply:
177
[(old_path, new_path, file_id, new_inventory_entry), ...]
184
:param changes: An inventory delta to apply to the working tree's
187
:seealso Inventory.apply_delta: For details on the changes parameter.
182
for old_path, file_id in sorted(((op, f) for op, np, f, e in changes
183
if op is not None), reverse=True):
184
if file_id not in inv:
186
children[file_id] = getattr(inv[file_id], 'children', {})
187
inv.remove_recursive_id(file_id)
188
for new_path, new_entry in sorted((np, e) for op, np, f, e in
189
changes if np is not None):
190
if getattr(new_entry, 'children', None) is not None:
191
new_entry.children = children.get(new_entry.file_id, {})
193
self._write_inventory(inv)
189
raise NotImplementedError(self.apply_inventory_delta)
195
191
@needs_write_lock
196
192
def commit(self, message=None, revprops=None, *args,
198
194
# avoid circular imports
199
195
from bzrlib import commit
202
if not 'branch-nick' in revprops:
203
revprops['branch-nick'] = self.branch.nick
204
author = kwargs.pop('author', None)
205
if author is not None:
206
assert 'author' not in revprops
207
revprops['author'] = author
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)
208
204
# args for wt.commit start at message from the Commit.commit method,
209
205
args = (message, ) + args
206
for hook in MutableTree.hooks['start_commit']:
210
208
committed_id = commit.Commit().commit(working_tree=self,
211
revprops=revprops, *args, **kwargs)
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)
212
215
return committed_id
214
217
def _gather_kinds(self, files, kinds):
271
367
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
272
368
"""Set the parents of the working tree.
274
:param parents_list: A list of (revision_id, tree) tuples.
370
:param parents_list: A list of (revision_id, tree) tuples.
275
371
If tree is None, then that element is treated as an unreachable
276
372
parent tree - i.e. a ghost.
278
374
raise NotImplementedError(self.set_parent_trees)
280
@needs_tree_write_lock
281
def smart_add(self, file_list, recurse=True, action=None, save=True):
282
"""Version file_list, optionally recursing into directories.
284
This is designed more towards DWIM for humans than API clarity.
285
For the specific behaviour see the help for cmd_add().
287
:param action: A reporter to be called with the inventory, parent_ie,
288
path and kind of the path being added. It may return a file_id if
289
a specific one should be used.
290
:param save: Save the inventory after completing the adds. If False
291
this provides dry-run functionality by doing the add and not saving
293
:return: A tuple - files_added, ignored_files. files_added is the count
294
of added files, and ignored_files is a dict mapping files that were
295
ignored to the rule that caused them to be ignored.
297
# not in an inner loop; and we want to remove direct use of this,
298
# so here as a reminder for now. RBC 20070703
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
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))
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 "
536
# install the default hooks into the MutableTree class.
537
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):
299
660
from bzrlib.inventory import InventoryEntry
300
assert isinstance(recurse, bool)
302
action = add.AddAction()
304
661
if not file_list:
305
662
# no paths supplied: add the entire tree.
663
# FIXME: this assumes we are running in a working tree subdir :-/
306
665
file_list = [u'.']
307
# mutter("smart add of %r")
314
# validate user file paths and convert all paths to tree
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
315
675
# relative : it's cheaper to make a tree relative path an abspath
316
# than to convert an abspath to tree relative.
317
for filepath in file_list:
318
rf = _FastPath(self.relpath(filepath))
319
# validate user parameters. Our recursive code avoids adding new files
320
# that need such validation
321
if self.is_control_filename(rf.raw_path):
322
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
324
abspath = self.abspath(rf.raw_path)
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)
325
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)
326
694
if kind == 'directory':
327
695
# schedule the dir for scanning
330
if not InventoryEntry.versionable_kind(kind):
331
raise errors.BadFileKindError(filename=abspath, kind=kind)
332
# ensure the named path is added, so that ignore rules in the later directory
334
# we dont have a parent ie known yet.: use the relatively slower inventory
336
versioned = inv.has_filename(rf.raw_path)
339
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
696
user_dirs[filepath] = (inv_path, this_ie)
342
699
# no need to walk any directories at all.
343
if len(added) > 0 and save:
344
self._write_inventory(inv)
345
return added, ignored
347
# only walk the minimal parents needed: we have user_dirs to override
351
is_inside = osutils.is_inside_or_parent_of_any
352
for path in sorted(user_dirs):
353
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
354
dirs_to_add.append((path, None))
355
prev_dir = path.raw_path
357
# dirs_to_add is initialised to a list of directories, but as we scan
358
# directories we append files to it.
359
# XXX: We should determine kind of files when we scan them rather than
360
# adding to this list. RBC 20070703
361
for directory, parent_ie in dirs_to_add:
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:
362
706
# directory is tree-relative
363
abspath = self.abspath(directory.raw_path)
707
abspath = self.tree.abspath(directory)
365
709
# get the contents of this directory.
367
# find the kind of the path being added.
368
kind = osutils.file_kind(abspath)
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):
370
723
if not InventoryEntry.versionable_kind(kind):
371
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
374
if parent_ie is not None:
375
versioned = directory.base_path in parent_ie.children
377
# without the parent ie, use the relatively slower inventory
379
versioned = inv.has_filename(directory.raw_path)
381
if kind == 'directory':
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 != '':
383
sub_branch = bzrdir.BzrDir.open(abspath)
740
transport = _mod_transport.get_transport_from_path(abspath)
741
controldir.ControlDirFormat.find_format(transport)
385
743
except errors.NotBranchError:
392
if directory.raw_path == '':
393
# mutter("tree root doesn't need to be added")
750
if this_ie is not None:
397
# mutter("%r is already versioned", abspath)
399
# XXX: This is wrong; people *might* reasonably be trying to add
400
# subtrees as subtrees. This should probably only be done in formats
401
# which can represent subtrees, and even then perhaps only when
402
# the user asked to add subtrees. At the moment you can add them
403
# specially through 'join --reference', which is perhaps
404
# reasonable: adding a new reference is a special operation and
405
# can have a special behaviour. mbp 20070306
406
mutter("%r is a nested bzr tree", abspath)
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)
408
_add_one(self, inv, parent_ie, directory, kind, action)
409
added.append(directory.raw_path)
763
this_ie = self._add_one_and_parent(parent_ie, directory, kind,
411
766
if kind == 'directory' and not sub_tree:
412
if parent_ie is not None:
414
this_ie = parent_ie.children[directory.base_path]
416
# without the parent ie, use the relatively slower inventory
418
this_id = inv.path2id(directory.raw_path)
422
this_ie = inv[this_id]
767
if this_ie.kind != 'directory':
768
this_ie = self._convert_to_directory(this_ie, inv_path)
424
770
for subf in sorted(os.listdir(abspath)):
425
# here we could use TreeDirectory rather than
771
inv_f, _ = osutils.normalized_filename(subf)
772
# here we could use TreeDirectory rather than
426
773
# string concatenation.
427
subp = osutils.pathjoin(directory.raw_path, subf)
428
# TODO: is_control_filename is very slow. Make it faster.
429
# TreeDirectory.is_control_filename could also make this
430
# faster - its impossible for a non root dir to have a
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
432
if self.is_control_filename(subp):
433
mutter("skip control directory %r", subp)
434
elif subf in this_ie.children:
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:
435
789
# recurse into this already versioned subdir.
436
dirs_to_add.append((_FastPath(subp, subf), this_ie))
790
things_to_add.append((subp, sub_invp, sub_ie, this_ie))
438
# user selection overrides ignoes
792
# user selection overrides ignores
439
793
# ignore while selecting files - if we globbed in the
440
794
# outer loop we would ignore user files.
441
ignore_glob = self.is_ignored(subp)
795
ignore_glob = self.tree.is_ignored(subp)
442
796
if ignore_glob is not None:
443
# mutter("skip ignored sub-file %r", subp)
444
ignored.setdefault(ignore_glob, []).append(subp)
797
self.ignored.setdefault(ignore_glob, []).append(subp)
446
#mutter("queue to add sub-file %r", subp)
447
dirs_to_add.append((_FastPath(subp, subf), this_ie))
451
self._write_inventory(inv)
453
self.read_working_inventory()
454
return added, ignored
457
class _FastPath(object):
458
"""A path object with fast accessors for things like basename."""
460
__slots__ = ['raw_path', 'base_path']
462
def __init__(self, path, base_path=None):
463
"""Construct a FastPath from path."""
464
if base_path is None:
465
self.base_path = osutils.basename(path)
467
self.base_path = base_path
470
def __cmp__(self, other):
471
return cmp(self.raw_path, other.raw_path)
474
return hash(self.raw_path)
477
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
478
"""Add a new entry to the inventory and automatically add unversioned parents.
480
:param inv: Inventory which will receive the new entry.
481
:param parent_ie: Parent inventory entry if known, or None. If
482
None, the parent is looked up by name and used if present, otherwise it
483
is recursively added.
484
:param kind: Kind of new entry (file, directory, etc)
485
:param action: callback(inv, parent_ie, path, kind); return ignored.
486
:return: A list of paths which have been added.
488
# Nothing to do if path is already versioned.
489
# This is safe from infinite recursion because the tree root is
491
if parent_ie is not None:
492
# we have a parent ie already
495
# slower but does not need parent_ie
496
if inv.has_filename(path.raw_path):
498
# its really not there : add the parent
499
# note that the dirname use leads to some extra str copying etc but as
500
# there are a limited number of dirs we can be nested under, it should
501
# generally find it very fast and not recurse after that.
502
added = _add_one_and_parent(tree, inv, None,
503
_FastPath(dirname(path.raw_path)), 'directory', action)
504
parent_id = inv.path2id(dirname(path.raw_path))
505
parent_ie = inv[parent_id]
506
_add_one(tree, inv, parent_ie, path, kind, action)
507
return added + [path.raw_path]
510
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
511
"""Add a new entry to the inventory.
513
:param inv: Inventory which will receive the new entry.
514
:param parent_ie: Parent inventory entry.
515
:param kind: Kind of new entry (file, directory, etc)
516
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
517
file_id or None to generate a new file id
520
file_id = file_id_callback(inv, parent_ie, path, kind)
521
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
799
things_to_add.append((subp, sub_invp, None, this_ie))
added
removed
bzrlib/mutabletree.py
