304
246
raise NotImplementedError(self.mkdir)
306
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
307
"""Tell the tree we have observed a paths sha1.
309
The intent of this function is to allow trees that have a hashcache to
310
update the hashcache during commit. If the observed file is too new
311
(based on the stat_value) to be safely hash-cached the tree will ignore
314
The default implementation does nothing.
316
:param file_id: The file id
317
:param path: The file path
318
:param sha1: The sha 1 that was observed.
319
:param stat_value: A stat result for the file the sha1 was read from.
323
def _fix_case_of_inventory_path(self, path):
324
"""If our tree isn't case sensitive, return the canonical path"""
325
if not self.case_sensitive:
326
path = self.get_canonical_inventory_path(path)
330
def put_file_bytes_non_atomic(self, file_id, bytes):
331
"""Update the content of a file in the tree.
333
Note that the file is written in-place rather than being
334
written to a temporary location and renamed. As a consequence,
335
readers can potentially see the file half-written.
337
:param file_id: file-id of the file
338
:param bytes: the new file contents
340
raise NotImplementedError(self.put_file_bytes_non_atomic)
342
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
343
"""Set the parents ids of the working tree.
345
:param revision_ids: A list of revision_ids.
347
raise NotImplementedError(self.set_parent_ids)
349
248
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
350
249
"""Set the parents of the working tree.
352
:param parents_list: A list of (revision_id, tree) tuples.
251
:param parents_list: A list of (revision_id, tree) tuples.
353
252
If tree is None, then that element is treated as an unreachable
354
253
parent tree - i.e. a ghost.
356
255
raise NotImplementedError(self.set_parent_trees)
358
@needs_tree_write_lock
359
def smart_add(self, file_list, recurse=True, action=None, save=True):
360
"""Version file_list, optionally recursing into directories.
362
This is designed more towards DWIM for humans than API clarity.
363
For the specific behaviour see the help for cmd_add().
365
:param action: A reporter to be called with the inventory, parent_ie,
366
path and kind of the path being added. It may return a file_id if
367
a specific one should be used.
368
:param save: Save the inventory after completing the adds. If False
369
this provides dry-run functionality by doing the add and not saving
371
:return: A tuple - files_added, ignored_files. files_added is the count
372
of added files, and ignored_files is a dict mapping files that were
373
ignored to the rule that caused them to be ignored.
375
# not in an inner loop; and we want to remove direct use of this,
376
# so here as a reminder for now. RBC 20070703
377
from bzrlib.inventory import InventoryEntry
379
action = add.AddAction()
382
# no paths supplied: add the entire tree.
383
# FIXME: this assumes we are running in a working tree subdir :-/
386
# mutter("smart add of %r")
392
conflicts_related = set()
393
# Not all mutable trees can have conflicts
394
if getattr(self, 'conflicts', None) is not None:
395
# Collect all related files without checking whether they exist or
396
# are versioned. It's cheaper to do that once for all conflicts
397
# than trying to find the relevant conflict for each added file.
398
for c in self.conflicts():
399
conflicts_related.update(c.associated_filenames())
401
# validate user file paths and convert all paths to tree
402
# relative : it's cheaper to make a tree relative path an abspath
403
# than to convert an abspath to tree relative, and it's cheaper to
404
# perform the canonicalization in bulk.
405
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
406
rf = _FastPath(filepath)
407
# validate user parameters. Our recursive code avoids adding new
408
# files that need such validation
409
if self.is_control_filename(rf.raw_path):
410
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
412
abspath = self.abspath(rf.raw_path)
413
kind = osutils.file_kind(abspath)
414
if kind == 'directory':
415
# schedule the dir for scanning
418
if not InventoryEntry.versionable_kind(kind):
419
raise errors.BadFileKindError(filename=abspath, kind=kind)
420
# ensure the named path is added, so that ignore rules in the later
421
# directory walk dont skip it.
422
# we dont have a parent ie known yet.: use the relatively slower
423
# inventory probing method
424
versioned = inv.has_filename(rf.raw_path)
427
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
430
# no need to walk any directories at all.
431
if len(added) > 0 and save:
432
self._write_inventory(inv)
433
return added, ignored
435
# only walk the minimal parents needed: we have user_dirs to override
439
is_inside = osutils.is_inside_or_parent_of_any
440
for path in sorted(user_dirs):
441
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
442
dirs_to_add.append((path, None))
443
prev_dir = path.raw_path
445
illegalpath_re = re.compile(r'[\r\n]')
446
# dirs_to_add is initialised to a list of directories, but as we scan
447
# directories we append files to it.
448
# XXX: We should determine kind of files when we scan them rather than
449
# adding to this list. RBC 20070703
450
for directory, parent_ie in dirs_to_add:
451
# directory is tree-relative
452
abspath = self.abspath(directory.raw_path)
454
# get the contents of this directory.
456
# find the kind of the path being added.
457
kind = osutils.file_kind(abspath)
459
if not InventoryEntry.versionable_kind(kind):
460
trace.warning("skipping %s (can't add file of kind '%s')",
463
if illegalpath_re.search(directory.raw_path):
464
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
466
if directory.raw_path in conflicts_related:
467
# If the file looks like one generated for a conflict, don't
470
'skipping %s (generated to help resolve conflicts)',
474
if parent_ie is not None:
475
versioned = directory.base_path in parent_ie.children
477
# without the parent ie, use the relatively slower inventory
479
versioned = inv.has_filename(
480
self._fix_case_of_inventory_path(directory.raw_path))
482
if kind == 'directory':
484
sub_branch = bzrdir.BzrDir.open(abspath)
486
except errors.NotBranchError:
488
except errors.UnsupportedFormatError:
493
if directory.raw_path == '':
494
# mutter("tree root doesn't need to be added")
498
# mutter("%r is already versioned", abspath)
500
# XXX: This is wrong; people *might* reasonably be trying to
501
# add subtrees as subtrees. This should probably only be done
502
# in formats which can represent subtrees, and even then
503
# perhaps only when the user asked to add subtrees. At the
504
# moment you can add them specially through 'join --reference',
505
# which is perhaps reasonable: adding a new reference is a
506
# special operation and can have a special behaviour. mbp
508
trace.mutter("%r is a nested bzr tree", abspath)
510
_add_one(self, inv, parent_ie, directory, kind, action)
511
added.append(directory.raw_path)
513
if kind == 'directory' and not sub_tree:
514
if parent_ie is not None:
516
this_ie = parent_ie.children[directory.base_path]
518
# without the parent ie, use the relatively slower inventory
520
this_id = inv.path2id(
521
self._fix_case_of_inventory_path(directory.raw_path))
525
this_ie = inv[this_id]
527
for subf in sorted(os.listdir(abspath)):
528
# here we could use TreeDirectory rather than
529
# string concatenation.
530
subp = osutils.pathjoin(directory.raw_path, subf)
531
# TODO: is_control_filename is very slow. Make it faster.
532
# TreeDirectory.is_control_filename could also make this
533
# faster - its impossible for a non root dir to have a
535
if self.is_control_filename(subp):
536
trace.mutter("skip control directory %r", subp)
537
elif subf in this_ie.children:
538
# recurse into this already versioned subdir.
539
dirs_to_add.append((_FastPath(subp, subf), this_ie))
541
# user selection overrides ignoes
542
# ignore while selecting files - if we globbed in the
543
# outer loop we would ignore user files.
544
ignore_glob = self.is_ignored(subp)
545
if ignore_glob is not None:
546
# mutter("skip ignored sub-file %r", subp)
547
ignored.setdefault(ignore_glob, []).append(subp)
549
#mutter("queue to add sub-file %r", subp)
550
dirs_to_add.append((_FastPath(subp, subf), this_ie))
554
self._write_inventory(inv)
556
self.read_working_inventory()
557
return added, ignored
559
def update_basis_by_delta(self, new_revid, delta):
560
"""Update the parents of this tree after a commit.
562
This gives the tree one parent, with revision id new_revid. The
563
inventory delta is applied to the current basis tree to generate the
564
inventory for the parent new_revid, and all other parent trees are
567
All the changes in the delta should be changes synchronising the basis
568
tree with some or all of the working tree, with a change to a directory
569
requiring that its contents have been recursively included. That is,
570
this is not a general purpose tree modification routine, but a helper
571
for commit which is not required to handle situations that do not arise
574
See the inventory developers documentation for the theory behind
577
:param new_revid: The new revision id for the trees parent.
578
:param delta: An inventory delta (see apply_inventory_delta) describing
579
the changes from the current left most parent revision to new_revid.
581
# if the tree is updated by a pull to the branch, as happens in
582
# WorkingTree2, when there was no separation between branch and tree,
583
# then just clear merges, efficiency is not a concern for now as this
584
# is legacy environments only, and they are slow regardless.
585
if self.last_revision() == new_revid:
586
self.set_parent_ids([new_revid])
588
# generic implementation based on Inventory manipulation. See
589
# WorkingTree classes for optimised versions for specific format trees.
590
basis = self.basis_tree()
592
# TODO: Consider re-evaluating the need for this with CHKInventory
593
# we don't strictly need to mutate an inventory for this
594
# it only makes sense when apply_delta is cheaper than get_inventory()
595
inventory = basis.inventory._get_mutable_inventory()
597
inventory.apply_delta(delta)
598
rev_tree = revisiontree.RevisionTree(self.branch.repository,
599
inventory, new_revid)
600
self.set_parent_trees([(new_revid, rev_tree)])
603
class MutableTreeHooks(hooks.Hooks):
604
"""A dictionary mapping a hook name to a list of callables for mutabletree
609
"""Create the default hooks.
612
hooks.Hooks.__init__(self)
613
self.create_hook(hooks.HookPoint('start_commit',
614
"Called before a commit is performed on a tree. The start commit "
615
"hook is able to change the tree before the commit takes place. "
616
"start_commit is called with the bzrlib.mutabletree.MutableTree "
617
"that the commit is being performed on.", (1, 4), None))
618
self.create_hook(hooks.HookPoint('post_commit',
619
"Called after a commit is performed on a tree. The hook is "
620
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
621
"The mutable tree the commit was performed on is available via "
622
"the mutable_tree attribute of that object.", (2, 0), None))
625
# install the default hooks into the MutableTree class.
626
MutableTree.hooks = MutableTreeHooks()
629
class PostCommitHookParams(object):
630
"""Parameters for the post_commit hook.
632
To access the parameters, use the following attributes:
634
* mutable_tree - the MutableTree object
637
def __init__(self, mutable_tree):
638
"""Create the parameters for the post_commit hook."""
639
self.mutable_tree = mutable_tree
642
class _FastPath(object):
643
"""A path object with fast accessors for things like basename."""
645
__slots__ = ['raw_path', 'base_path']
647
def __init__(self, path, base_path=None):
648
"""Construct a FastPath from path."""
649
if base_path is None:
650
self.base_path = osutils.basename(path)
652
self.base_path = base_path
655
def __cmp__(self, other):
656
return cmp(self.raw_path, other.raw_path)
659
return hash(self.raw_path)
662
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
663
"""Add a new entry to the inventory and automatically add unversioned parents.
665
:param inv: Inventory which will receive the new entry.
666
:param parent_ie: Parent inventory entry if known, or None. If
667
None, the parent is looked up by name and used if present, otherwise it
668
is recursively added.
669
:param kind: Kind of new entry (file, directory, etc)
670
:param action: callback(inv, parent_ie, path, kind); return ignored.
671
:return: A list of paths which have been added.
673
# Nothing to do if path is already versioned.
674
# This is safe from infinite recursion because the tree root is
676
if parent_ie is not None:
677
# we have a parent ie already
680
# slower but does not need parent_ie
681
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
683
# its really not there : add the parent
684
# note that the dirname use leads to some extra str copying etc but as
685
# there are a limited number of dirs we can be nested under, it should
686
# generally find it very fast and not recurse after that.
687
added = _add_one_and_parent(tree, inv, None,
688
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
689
parent_id = inv.path2id(osutils.dirname(path.raw_path))
690
parent_ie = inv[parent_id]
691
_add_one(tree, inv, parent_ie, path, kind, action)
692
return added + [path.raw_path]
695
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
696
"""Add a new entry to the inventory.
698
:param inv: Inventory which will receive the new entry.
699
:param parent_ie: Parent inventory entry.
700
:param kind: Kind of new entry (file, directory, etc)
701
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
702
file_id or None to generate a new file id
705
file_id = file_id_callback(inv, parent_ie, path, kind)
706
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
