296
246
raise NotImplementedError(self.mkdir)
298
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
299
"""Tell the tree we have observed a paths sha1.
301
The intent of this function is to allow trees that have a hashcache to
302
update the hashcache during commit. If the observed file is too new
303
(based on the stat_value) to be safely hash-cached the tree will ignore
306
The default implementation does nothing.
308
:param file_id: The file id
309
:param path: The file path
310
:param sha1: The sha 1 that was observed.
311
:param stat_value: A stat result for the file the sha1 was read from.
315
def _fix_case_of_inventory_path(self, path):
316
"""If our tree isn't case sensitive, return the canonical path"""
317
if not self.case_sensitive:
318
path = self.get_canonical_inventory_path(path)
322
def put_file_bytes_non_atomic(self, file_id, bytes):
323
"""Update the content of a file in the tree.
325
Note that the file is written in-place rather than being
326
written to a temporary location and renamed. As a consequence,
327
readers can potentially see the file half-written.
329
:param file_id: file-id of the file
330
:param bytes: the new file contents
332
raise NotImplementedError(self.put_file_bytes_non_atomic)
334
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
335
"""Set the parents ids of the working tree.
337
:param revision_ids: A list of revision_ids.
339
raise NotImplementedError(self.set_parent_ids)
341
248
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
342
249
"""Set the parents of the working tree.
344
:param parents_list: A list of (revision_id, tree) tuples.
251
:param parents_list: A list of (revision_id, tree) tuples.
345
252
If tree is None, then that element is treated as an unreachable
346
253
parent tree - i.e. a ghost.
348
255
raise NotImplementedError(self.set_parent_trees)
350
@needs_tree_write_lock
351
def smart_add(self, file_list, recurse=True, action=None, save=True):
352
"""Version file_list, optionally recursing into directories.
354
This is designed more towards DWIM for humans than API clarity.
355
For the specific behaviour see the help for cmd_add().
357
:param action: A reporter to be called with the inventory, parent_ie,
358
path and kind of the path being added. It may return a file_id if
359
a specific one should be used.
360
:param save: Save the inventory after completing the adds. If False
361
this provides dry-run functionality by doing the add and not saving
363
:return: A tuple - files_added, ignored_files. files_added is the count
364
of added files, and ignored_files is a dict mapping files that were
365
ignored to the rule that caused them to be ignored.
367
# not in an inner loop; and we want to remove direct use of this,
368
# so here as a reminder for now. RBC 20070703
369
from bzrlib.inventory import InventoryEntry
371
action = add.AddAction()
374
# no paths supplied: add the entire tree.
376
# mutter("smart add of %r")
383
# validate user file paths and convert all paths to tree
384
# relative : it's cheaper to make a tree relative path an abspath
385
# than to convert an abspath to tree relative, and it's cheaper to
386
# perform the canonicalization in bulk.
387
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
388
rf = _FastPath(filepath)
389
# validate user parameters. Our recursive code avoids adding new files
390
# that need such validation
391
if self.is_control_filename(rf.raw_path):
392
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
394
abspath = self.abspath(rf.raw_path)
395
kind = osutils.file_kind(abspath)
396
if kind == 'directory':
397
# schedule the dir for scanning
400
if not InventoryEntry.versionable_kind(kind):
401
raise errors.BadFileKindError(filename=abspath, kind=kind)
402
# ensure the named path is added, so that ignore rules in the later directory
404
# we dont have a parent ie known yet.: use the relatively slower inventory
406
versioned = inv.has_filename(rf.raw_path)
409
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
412
# no need to walk any directories at all.
413
if len(added) > 0 and save:
414
self._write_inventory(inv)
415
return added, ignored
417
# only walk the minimal parents needed: we have user_dirs to override
421
is_inside = osutils.is_inside_or_parent_of_any
422
for path in sorted(user_dirs):
423
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
424
dirs_to_add.append((path, None))
425
prev_dir = path.raw_path
427
# dirs_to_add is initialised to a list of directories, but as we scan
428
# directories we append files to it.
429
# XXX: We should determine kind of files when we scan them rather than
430
# adding to this list. RBC 20070703
431
for directory, parent_ie in dirs_to_add:
432
# directory is tree-relative
433
abspath = self.abspath(directory.raw_path)
435
# get the contents of this directory.
437
# find the kind of the path being added.
438
kind = osutils.file_kind(abspath)
440
if not InventoryEntry.versionable_kind(kind):
441
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
444
if parent_ie is not None:
445
versioned = directory.base_path in parent_ie.children
447
# without the parent ie, use the relatively slower inventory
449
versioned = inv.has_filename(
450
self._fix_case_of_inventory_path(directory.raw_path))
452
if kind == 'directory':
454
sub_branch = bzrdir.BzrDir.open(abspath)
456
except errors.NotBranchError:
458
except errors.UnsupportedFormatError:
463
if directory.raw_path == '':
464
# mutter("tree root doesn't need to be added")
468
# mutter("%r is already versioned", abspath)
470
# XXX: This is wrong; people *might* reasonably be trying to add
471
# subtrees as subtrees. This should probably only be done in formats
472
# which can represent subtrees, and even then perhaps only when
473
# the user asked to add subtrees. At the moment you can add them
474
# specially through 'join --reference', which is perhaps
475
# reasonable: adding a new reference is a special operation and
476
# can have a special behaviour. mbp 20070306
477
mutter("%r is a nested bzr tree", abspath)
479
_add_one(self, inv, parent_ie, directory, kind, action)
480
added.append(directory.raw_path)
482
if kind == 'directory' and not sub_tree:
483
if parent_ie is not None:
485
this_ie = parent_ie.children[directory.base_path]
487
# without the parent ie, use the relatively slower inventory
489
this_id = inv.path2id(
490
self._fix_case_of_inventory_path(directory.raw_path))
494
this_ie = inv[this_id]
496
for subf in sorted(os.listdir(abspath)):
497
# here we could use TreeDirectory rather than
498
# string concatenation.
499
subp = osutils.pathjoin(directory.raw_path, subf)
500
# TODO: is_control_filename is very slow. Make it faster.
501
# TreeDirectory.is_control_filename could also make this
502
# faster - its impossible for a non root dir to have a
504
if self.is_control_filename(subp):
505
mutter("skip control directory %r", subp)
506
elif subf in this_ie.children:
507
# recurse into this already versioned subdir.
508
dirs_to_add.append((_FastPath(subp, subf), this_ie))
510
# user selection overrides ignoes
511
# ignore while selecting files - if we globbed in the
512
# outer loop we would ignore user files.
513
ignore_glob = self.is_ignored(subp)
514
if ignore_glob is not None:
515
# mutter("skip ignored sub-file %r", subp)
516
ignored.setdefault(ignore_glob, []).append(subp)
518
#mutter("queue to add sub-file %r", subp)
519
dirs_to_add.append((_FastPath(subp, subf), this_ie))
523
self._write_inventory(inv)
525
self.read_working_inventory()
526
return added, ignored
528
def update_basis_by_delta(self, new_revid, delta):
529
"""Update the parents of this tree after a commit.
531
This gives the tree one parent, with revision id new_revid. The
532
inventory delta is applied to the current basis tree to generate the
533
inventory for the parent new_revid, and all other parent trees are
536
All the changes in the delta should be changes synchronising the basis
537
tree with some or all of the working tree, with a change to a directory
538
requiring that its contents have been recursively included. That is,
539
this is not a general purpose tree modification routine, but a helper
540
for commit which is not required to handle situations that do not arise
543
See the inventory developers documentation for the theory behind
546
:param new_revid: The new revision id for the trees parent.
547
:param delta: An inventory delta (see apply_inventory_delta) describing
548
the changes from the current left most parent revision to new_revid.
550
# if the tree is updated by a pull to the branch, as happens in
551
# WorkingTree2, when there was no separation between branch and tree,
552
# then just clear merges, efficiency is not a concern for now as this
553
# is legacy environments only, and they are slow regardless.
554
if self.last_revision() == new_revid:
555
self.set_parent_ids([new_revid])
557
# generic implementation based on Inventory manipulation. See
558
# WorkingTree classes for optimised versions for specific format trees.
559
basis = self.basis_tree()
561
# TODO: Consider re-evaluating the need for this with CHKInventory
562
# we don't strictly need to mutate an inventory for this
563
# it only makes sense when apply_delta is cheaper than get_inventory()
564
inventory = basis.inventory._get_mutable_inventory()
566
inventory.apply_delta(delta)
567
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
568
self.set_parent_trees([(new_revid, rev_tree)])
571
class MutableTreeHooks(hooks.Hooks):
572
"""A dictionary mapping a hook name to a list of callables for mutabletree
577
"""Create the default hooks.
580
hooks.Hooks.__init__(self)
581
self.create_hook(hooks.HookPoint('start_commit',
582
"Called before a commit is performed on a tree. The start commit "
583
"hook is able to change the tree before the commit takes place. "
584
"start_commit is called with the bzrlib.tree.MutableTree that the "
585
"commit is being performed on.", (1, 4), None))
588
# install the default hooks into the MutableTree class.
589
MutableTree.hooks = MutableTreeHooks()
592
class _FastPath(object):
593
"""A path object with fast accessors for things like basename."""
595
__slots__ = ['raw_path', 'base_path']
597
def __init__(self, path, base_path=None):
598
"""Construct a FastPath from path."""
599
if base_path is None:
600
self.base_path = osutils.basename(path)
602
self.base_path = base_path
605
def __cmp__(self, other):
606
return cmp(self.raw_path, other.raw_path)
609
return hash(self.raw_path)
612
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
613
"""Add a new entry to the inventory and automatically add unversioned parents.
615
:param inv: Inventory which will receive the new entry.
616
:param parent_ie: Parent inventory entry if known, or None. If
617
None, the parent is looked up by name and used if present, otherwise it
618
is recursively added.
619
:param kind: Kind of new entry (file, directory, etc)
620
:param action: callback(inv, parent_ie, path, kind); return ignored.
621
:return: A list of paths which have been added.
623
# Nothing to do if path is already versioned.
624
# This is safe from infinite recursion because the tree root is
626
if parent_ie is not None:
627
# we have a parent ie already
630
# slower but does not need parent_ie
631
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
633
# its really not there : add the parent
634
# note that the dirname use leads to some extra str copying etc but as
635
# there are a limited number of dirs we can be nested under, it should
636
# generally find it very fast and not recurse after that.
637
added = _add_one_and_parent(tree, inv, None,
638
_FastPath(dirname(path.raw_path)), 'directory', action)
639
parent_id = inv.path2id(dirname(path.raw_path))
640
parent_ie = inv[parent_id]
641
_add_one(tree, inv, parent_ie, path, kind, action)
642
return added + [path.raw_path]
645
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
646
"""Add a new entry to the inventory.
648
:param inv: Inventory which will receive the new entry.
649
:param parent_ie: Parent inventory entry.
650
:param kind: Kind of new entry (file, directory, etc)
651
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
652
file_id or None to generate a new file id
655
file_id = file_id_callback(inv, parent_ie, path, kind)
656
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,