317
246
raise NotImplementedError(self.mkdir)
319
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
320
"""Tell the tree we have observed a paths sha1.
322
The intent of this function is to allow trees that have a hashcache to
323
update the hashcache during commit. If the observed file is too new
324
(based on the stat_value) to be safely hash-cached the tree will ignore
327
The default implementation does nothing.
329
:param file_id: The file id
330
:param path: The file path
331
:param sha1: The sha 1 that was observed.
332
:param stat_value: A stat result for the file the sha1 was read from.
336
def _fix_case_of_inventory_path(self, path):
337
"""If our tree isn't case sensitive, return the canonical path"""
338
if not self.case_sensitive:
339
path = self.get_canonical_inventory_path(path)
343
def put_file_bytes_non_atomic(self, file_id, bytes):
344
"""Update the content of a file in the tree.
346
Note that the file is written in-place rather than being
347
written to a temporary location and renamed. As a consequence,
348
readers can potentially see the file half-written.
350
:param file_id: file-id of the file
351
:param bytes: the new file contents
353
raise NotImplementedError(self.put_file_bytes_non_atomic)
355
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
356
"""Set the parents ids of the working tree.
358
:param revision_ids: A list of revision_ids.
360
raise NotImplementedError(self.set_parent_ids)
362
248
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
363
249
"""Set the parents of the working tree.
365
:param parents_list: A list of (revision_id, tree) tuples.
251
:param parents_list: A list of (revision_id, tree) tuples.
366
252
If tree is None, then that element is treated as an unreachable
367
253
parent tree - i.e. a ghost.
369
255
raise NotImplementedError(self.set_parent_trees)
371
@needs_tree_write_lock
372
def smart_add(self, file_list, recurse=True, action=None, save=True):
373
"""Version file_list, optionally recursing into directories.
375
This is designed more towards DWIM for humans than API clarity.
376
For the specific behaviour see the help for cmd_add().
378
:param action: A reporter to be called with the inventory, parent_ie,
379
path and kind of the path being added. It may return a file_id if
380
a specific one should be used.
381
:param save: Save the inventory after completing the adds. If False
382
this provides dry-run functionality by doing the add and not saving
384
:return: A tuple - files_added, ignored_files. files_added is the count
385
of added files, and ignored_files is a dict mapping files that were
386
ignored to the rule that caused them to be ignored.
388
# not in an inner loop; and we want to remove direct use of this,
389
# so here as a reminder for now. RBC 20070703
390
from bzrlib.inventory import InventoryEntry
392
action = add.AddAction()
395
# no paths supplied: add the entire tree.
396
# FIXME: this assumes we are running in a working tree subdir :-/
399
# mutter("smart add of %r")
405
conflicts_related = set()
406
# Not all mutable trees can have conflicts
407
if getattr(self, 'conflicts', None) is not None:
408
# Collect all related files without checking whether they exist or
409
# are versioned. It's cheaper to do that once for all conflicts
410
# than trying to find the relevant conflict for each added file.
411
for c in self.conflicts():
412
conflicts_related.update(c.associated_filenames())
414
# validate user file paths and convert all paths to tree
415
# relative : it's cheaper to make a tree relative path an abspath
416
# than to convert an abspath to tree relative, and it's cheaper to
417
# perform the canonicalization in bulk.
418
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
419
rf = _FastPath(filepath)
420
# validate user parameters. Our recursive code avoids adding new
421
# files that need such validation
422
if self.is_control_filename(rf.raw_path):
423
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
425
abspath = self.abspath(rf.raw_path)
426
kind = osutils.file_kind(abspath)
427
if kind == 'directory':
428
# schedule the dir for scanning
431
if not InventoryEntry.versionable_kind(kind):
432
raise errors.BadFileKindError(filename=abspath, kind=kind)
433
# ensure the named path is added, so that ignore rules in the later
434
# directory walk dont skip it.
435
# we dont have a parent ie known yet.: use the relatively slower
436
# inventory probing method
437
versioned = inv.has_filename(rf.raw_path)
440
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
443
# no need to walk any directories at all.
444
if len(added) > 0 and save:
445
self._write_inventory(inv)
446
return added, ignored
448
# only walk the minimal parents needed: we have user_dirs to override
452
is_inside = osutils.is_inside_or_parent_of_any
453
for path in sorted(user_dirs):
454
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
455
dirs_to_add.append((path, None))
456
prev_dir = path.raw_path
458
illegalpath_re = re.compile(r'[\r\n]')
459
# dirs_to_add is initialised to a list of directories, but as we scan
460
# directories we append files to it.
461
# XXX: We should determine kind of files when we scan them rather than
462
# adding to this list. RBC 20070703
463
for directory, parent_ie in dirs_to_add:
464
# directory is tree-relative
465
abspath = self.abspath(directory.raw_path)
467
# get the contents of this directory.
469
# find the kind of the path being added.
470
kind = osutils.file_kind(abspath)
472
if not InventoryEntry.versionable_kind(kind):
473
trace.warning("skipping %s (can't add file of kind '%s')",
476
if illegalpath_re.search(directory.raw_path):
477
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
479
if directory.raw_path in conflicts_related:
480
# If the file looks like one generated for a conflict, don't
483
'skipping %s (generated to help resolve conflicts)',
487
if parent_ie is not None:
488
versioned = directory.base_path in parent_ie.children
490
# without the parent ie, use the relatively slower inventory
492
versioned = inv.has_filename(
493
self._fix_case_of_inventory_path(directory.raw_path))
495
if kind == 'directory':
497
sub_branch = bzrdir.BzrDir.open(abspath)
499
except errors.NotBranchError:
501
except errors.UnsupportedFormatError:
506
if directory.raw_path == '':
507
# mutter("tree root doesn't need to be added")
511
# mutter("%r is already versioned", abspath)
513
# XXX: This is wrong; people *might* reasonably be trying to
514
# add subtrees as subtrees. This should probably only be done
515
# in formats which can represent subtrees, and even then
516
# perhaps only when the user asked to add subtrees. At the
517
# moment you can add them specially through 'join --reference',
518
# which is perhaps reasonable: adding a new reference is a
519
# special operation and can have a special behaviour. mbp
521
trace.mutter("%r is a nested bzr tree", abspath)
523
_add_one(self, inv, parent_ie, directory, kind, action)
524
added.append(directory.raw_path)
526
if kind == 'directory' and not sub_tree:
527
if parent_ie is not None:
529
this_ie = parent_ie.children[directory.base_path]
531
# without the parent ie, use the relatively slower inventory
533
this_id = inv.path2id(
534
self._fix_case_of_inventory_path(directory.raw_path))
538
this_ie = inv[this_id]
540
for subf in sorted(os.listdir(abspath)):
541
# here we could use TreeDirectory rather than
542
# string concatenation.
543
subp = osutils.pathjoin(directory.raw_path, subf)
544
# TODO: is_control_filename is very slow. Make it faster.
545
# TreeDirectory.is_control_filename could also make this
546
# faster - its impossible for a non root dir to have a
548
if self.is_control_filename(subp):
549
trace.mutter("skip control directory %r", subp)
550
elif subf in this_ie.children:
551
# recurse into this already versioned subdir.
552
dirs_to_add.append((_FastPath(subp, subf), this_ie))
554
# user selection overrides ignoes
555
# ignore while selecting files - if we globbed in the
556
# outer loop we would ignore user files.
557
ignore_glob = self.is_ignored(subp)
558
if ignore_glob is not None:
559
# mutter("skip ignored sub-file %r", subp)
560
ignored.setdefault(ignore_glob, []).append(subp)
562
#mutter("queue to add sub-file %r", subp)
563
dirs_to_add.append((_FastPath(subp, subf), this_ie))
567
self._write_inventory(inv)
569
self.read_working_inventory()
570
return added, ignored
572
def update_basis_by_delta(self, new_revid, delta):
573
"""Update the parents of this tree after a commit.
575
This gives the tree one parent, with revision id new_revid. The
576
inventory delta is applied to the current basis tree to generate the
577
inventory for the parent new_revid, and all other parent trees are
580
All the changes in the delta should be changes synchronising the basis
581
tree with some or all of the working tree, with a change to a directory
582
requiring that its contents have been recursively included. That is,
583
this is not a general purpose tree modification routine, but a helper
584
for commit which is not required to handle situations that do not arise
587
See the inventory developers documentation for the theory behind
590
:param new_revid: The new revision id for the trees parent.
591
:param delta: An inventory delta (see apply_inventory_delta) describing
592
the changes from the current left most parent revision to new_revid.
594
# if the tree is updated by a pull to the branch, as happens in
595
# WorkingTree2, when there was no separation between branch and tree,
596
# then just clear merges, efficiency is not a concern for now as this
597
# is legacy environments only, and they are slow regardless.
598
if self.last_revision() == new_revid:
599
self.set_parent_ids([new_revid])
601
# generic implementation based on Inventory manipulation. See
602
# WorkingTree classes for optimised versions for specific format trees.
603
basis = self.basis_tree()
605
# TODO: Consider re-evaluating the need for this with CHKInventory
606
# we don't strictly need to mutate an inventory for this
607
# it only makes sense when apply_delta is cheaper than get_inventory()
608
inventory = basis.inventory._get_mutable_inventory()
610
inventory.apply_delta(delta)
611
rev_tree = revisiontree.RevisionTree(self.branch.repository,
612
inventory, new_revid)
613
self.set_parent_trees([(new_revid, rev_tree)])
616
class MutableTreeHooks(hooks.Hooks):
617
"""A dictionary mapping a hook name to a list of callables for mutabletree
622
"""Create the default hooks.
625
hooks.Hooks.__init__(self)
626
self.create_hook(hooks.HookPoint('start_commit',
627
"Called before a commit is performed on a tree. The start commit "
628
"hook is able to change the tree before the commit takes place. "
629
"start_commit is called with the bzrlib.mutabletree.MutableTree "
630
"that the commit is being performed on.", (1, 4), None))
631
self.create_hook(hooks.HookPoint('post_commit',
632
"Called after a commit is performed on a tree. The hook is "
633
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
634
"The mutable tree the commit was performed on is available via "
635
"the mutable_tree attribute of that object.", (2, 0), None))
638
# install the default hooks into the MutableTree class.
639
MutableTree.hooks = MutableTreeHooks()
642
class PostCommitHookParams(object):
643
"""Parameters for the post_commit hook.
645
To access the parameters, use the following attributes:
647
* mutable_tree - the MutableTree object
650
def __init__(self, mutable_tree):
651
"""Create the parameters for the post_commit hook."""
652
self.mutable_tree = mutable_tree
655
class _FastPath(object):
656
"""A path object with fast accessors for things like basename."""
658
__slots__ = ['raw_path', 'base_path']
660
def __init__(self, path, base_path=None):
661
"""Construct a FastPath from path."""
662
if base_path is None:
663
self.base_path = osutils.basename(path)
665
self.base_path = base_path
668
def __cmp__(self, other):
669
return cmp(self.raw_path, other.raw_path)
672
return hash(self.raw_path)
675
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
676
"""Add a new entry to the inventory and automatically add unversioned parents.
678
:param inv: Inventory which will receive the new entry.
679
:param parent_ie: Parent inventory entry if known, or None. If
680
None, the parent is looked up by name and used if present, otherwise it
681
is recursively added.
682
:param kind: Kind of new entry (file, directory, etc)
683
:param action: callback(inv, parent_ie, path, kind); return ignored.
684
:return: A list of paths which have been added.
686
# Nothing to do if path is already versioned.
687
# This is safe from infinite recursion because the tree root is
689
if parent_ie is not None:
690
# we have a parent ie already
693
# slower but does not need parent_ie
694
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
696
# its really not there : add the parent
697
# note that the dirname use leads to some extra str copying etc but as
698
# there are a limited number of dirs we can be nested under, it should
699
# generally find it very fast and not recurse after that.
700
added = _add_one_and_parent(tree, inv, None,
701
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
702
parent_id = inv.path2id(osutils.dirname(path.raw_path))
703
parent_ie = inv[parent_id]
704
_add_one(tree, inv, parent_ie, path, kind, action)
705
return added + [path.raw_path]
708
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
709
"""Add a new entry to the inventory.
711
:param inv: Inventory which will receive the new entry.
712
:param parent_ie: Parent inventory entry.
713
:param kind: Kind of new entry (file, directory, etc)
714
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
715
file_id or None to generate a new file id
718
file_id = file_id_callback(inv, parent_ie, path, kind)
719
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
