260
255
parent tree - i.e. a ghost.
262
257
raise NotImplementedError(self.set_parent_trees)
259
@needs_tree_write_lock
260
def smart_add(self, file_list, recurse=True, action=None, save=True):
261
"""Version file_list, optionally recursing into directories.
263
This is designed more towards DWIM for humans than API clarity.
264
For the specific behaviour see the help for cmd_add().
266
:param action: A reporter to be called with the inventory, parent_ie,
267
path and kind of the path being added. It may return a file_id if
268
a specific one should be used.
269
:param save: Save the inventory after completing the adds. If False
270
this provides dry-run functionality by doing the add and not saving
272
:return: A tuple - files_added, ignored_files. files_added is the count
273
of added files, and ignored_files is a dict mapping files that were
274
ignored to the rule that caused them to be ignored.
276
# not in an inner loop; and we want to remove direct use of this,
277
# so here as a reminder for now. RBC 20070703
278
from bzrlib.inventory import InventoryEntry
279
assert isinstance(recurse, bool)
281
action = add.AddAction()
284
# no paths supplied: add the entire tree.
286
# mutter("smart add of %r")
293
# validate user file paths and convert all paths to tree
294
# relative : it's cheaper to make a tree relative path an abspath
295
# than to convert an abspath to tree relative.
296
for filepath in file_list:
297
rf = _FastPath(self.relpath(filepath))
298
# validate user parameters. Our recursive code avoids adding new files
299
# that need such validation
300
if self.is_control_filename(rf.raw_path):
301
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
303
abspath = self.abspath(rf.raw_path)
304
kind = osutils.file_kind(abspath)
305
if kind == 'directory':
306
# schedule the dir for scanning
309
if not InventoryEntry.versionable_kind(kind):
310
raise errors.BadFileKindError(filename=abspath, kind=kind)
311
# ensure the named path is added, so that ignore rules in the later directory
313
# we dont have a parent ie known yet.: use the relatively slower inventory
315
versioned = inv.has_filename(rf.raw_path)
318
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
321
# no need to walk any directories at all.
322
if len(added) > 0 and save:
323
self._write_inventory(inv)
324
return added, ignored
326
# only walk the minimal parents needed: we have user_dirs to override
330
is_inside = osutils.is_inside_or_parent_of_any
331
for path in sorted(user_dirs):
332
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
333
dirs_to_add.append((path, None))
334
prev_dir = path.raw_path
336
# dirs_to_add is initialised to a list of directories, but as we scan
337
# directories we append files to it.
338
# XXX: We should determine kind of files when we scan them rather than
339
# adding to this list. RBC 20070703
340
for directory, parent_ie in dirs_to_add:
341
# directory is tree-relative
342
abspath = self.abspath(directory.raw_path)
344
# get the contents of this directory.
346
# find the kind of the path being added.
347
kind = osutils.file_kind(abspath)
349
if not InventoryEntry.versionable_kind(kind):
350
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
353
if parent_ie is not None:
354
versioned = directory.base_path in parent_ie.children
356
# without the parent ie, use the relatively slower inventory
358
versioned = inv.has_filename(directory.raw_path)
360
if kind == 'directory':
362
sub_branch = bzrdir.BzrDir.open(abspath)
364
except errors.NotBranchError:
366
except errors.UnsupportedFormatError:
371
if directory.raw_path == '':
372
# mutter("tree root doesn't need to be added")
376
# mutter("%r is already versioned", abspath)
378
# XXX: This is wrong; people *might* reasonably be trying to add
379
# subtrees as subtrees. This should probably only be done in formats
380
# which can represent subtrees, and even then perhaps only when
381
# the user asked to add subtrees. At the moment you can add them
382
# specially through 'join --reference', which is perhaps
383
# reasonable: adding a new reference is a special operation and
384
# can have a special behaviour. mbp 20070306
385
mutter("%r is a nested bzr tree", abspath)
387
_add_one(self, inv, parent_ie, directory, kind, action)
388
added.append(directory.raw_path)
390
if kind == 'directory' and not sub_tree:
391
if parent_ie is not None:
393
this_ie = parent_ie.children[directory.base_path]
395
# without the parent ie, use the relatively slower inventory
397
this_id = inv.path2id(directory.raw_path)
401
this_ie = inv[this_id]
403
for subf in sorted(os.listdir(abspath)):
404
# here we could use TreeDirectory rather than
405
# string concatenation.
406
subp = osutils.pathjoin(directory.raw_path, subf)
407
# TODO: is_control_filename is very slow. Make it faster.
408
# TreeDirectory.is_control_filename could also make this
409
# faster - its impossible for a non root dir to have a
411
if self.is_control_filename(subp):
412
mutter("skip control directory %r", subp)
413
elif subf in this_ie.children:
414
# recurse into this already versioned subdir.
415
dirs_to_add.append((_FastPath(subp, subf), this_ie))
417
# user selection overrides ignoes
418
# ignore while selecting files - if we globbed in the
419
# outer loop we would ignore user files.
420
ignore_glob = self.is_ignored(subp)
421
if ignore_glob is not None:
422
# mutter("skip ignored sub-file %r", subp)
423
ignored.setdefault(ignore_glob, []).append(subp)
425
#mutter("queue to add sub-file %r", subp)
426
dirs_to_add.append((_FastPath(subp, subf), this_ie))
430
self._write_inventory(inv)
432
self.read_working_inventory()
433
return added, ignored
435
def update_basis_by_delta(self, new_revid, delta):
436
"""Update the parents of this tree after a commit.
438
This gives the tree one parent, with revision id new_revid. The
439
inventory delta is applied to the current basis tree to generate the
440
inventory for the parent new_revid, and all other parent trees are
443
All the changes in the delta should be changes synchronising the basis
444
tree with some or all of the working tree, with a change to a directory
445
requiring that its contents have been recursively included. That is,
446
this is not a general purpose tree modification routine, but a helper
447
for commit which is not required to handle situations that do not arise
450
:param new_revid: The new revision id for the trees parent.
451
:param delta: An inventory delta (see apply_inventory_delta) describing
452
the changes from the current left most parent revision to new_revid.
454
# if the tree is updated by a pull to the branch, as happens in
455
# WorkingTree2, when there was no separation between branch and tree,
456
# then just clear merges, efficiency is not a concern for now as this
457
# is legacy environments only, and they are slow regardless.
458
if self.last_revision() == new_revid:
459
self.set_parent_ids([new_revid])
461
# generic implementation based on Inventory manipulation. See
462
# WorkingTree classes for optimised versions for specific format trees.
463
basis = self.basis_tree()
465
inventory = basis.inventory
467
inventory.apply_delta(delta)
468
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
469
self.set_parent_trees([(new_revid, rev_tree)])
472
class MutableTreeHooks(hooks.Hooks):
473
"""A dictionary mapping a hook name to a list of callables for mutabletree
478
"""Create the default hooks.
481
hooks.Hooks.__init__(self)
482
# Invoked before a commit is done in a tree. New in 1.4
483
self['start_commit'] = []
486
# install the default hooks into the MutableTree class.
487
MutableTree.hooks = MutableTreeHooks()
490
class _FastPath(object):
491
"""A path object with fast accessors for things like basename."""
493
__slots__ = ['raw_path', 'base_path']
495
def __init__(self, path, base_path=None):
496
"""Construct a FastPath from path."""
497
if base_path is None:
498
self.base_path = osutils.basename(path)
500
self.base_path = base_path
503
def __cmp__(self, other):
504
return cmp(self.raw_path, other.raw_path)
507
return hash(self.raw_path)
510
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
511
"""Add a new entry to the inventory and automatically add unversioned parents.
513
:param inv: Inventory which will receive the new entry.
514
:param parent_ie: Parent inventory entry if known, or None. If
515
None, the parent is looked up by name and used if present, otherwise it
516
is recursively added.
517
:param kind: Kind of new entry (file, directory, etc)
518
:param action: callback(inv, parent_ie, path, kind); return ignored.
519
:return: A list of paths which have been added.
521
# Nothing to do if path is already versioned.
522
# This is safe from infinite recursion because the tree root is
524
if parent_ie is not None:
525
# we have a parent ie already
528
# slower but does not need parent_ie
529
if inv.has_filename(path.raw_path):
531
# its really not there : add the parent
532
# note that the dirname use leads to some extra str copying etc but as
533
# there are a limited number of dirs we can be nested under, it should
534
# generally find it very fast and not recurse after that.
535
added = _add_one_and_parent(tree, inv, None,
536
_FastPath(dirname(path.raw_path)), 'directory', action)
537
parent_id = inv.path2id(dirname(path.raw_path))
538
parent_ie = inv[parent_id]
539
_add_one(tree, inv, parent_ie, path, kind, action)
540
return added + [path.raw_path]
543
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
544
"""Add a new entry to the inventory.
546
:param inv: Inventory which will receive the new entry.
547
:param parent_ie: Parent inventory entry.
548
:param kind: Kind of new entry (file, directory, etc)
549
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
550
file_id or None to generate a new file id
553
file_id = file_id_callback(inv, parent_ie, path, kind)
554
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
