206
208
revprops=revprops,
207
209
possible_master_transports=possible_master_transports,
211
post_hook_params = PostCommitHookParams(self)
212
for hook in MutableTree.hooks['post_commit']:
213
hook(post_hook_params)
209
214
return committed_id
211
216
def _gather_kinds(self, files, kinds):
212
217
"""Helper function for add - sets the entries of kinds."""
213
218
raise NotImplementedError(self._gather_kinds)
215
def get_file_with_stat(self, file_id, path=None):
216
"""Get a file handle and stat object for file_id.
218
The default implementation returns (self.get_file, None) for backwards
221
:param file_id: The file id to read.
222
:param path: The path of the file, if it is known.
223
:return: A tuple (file_handle, stat_value_or_None). If the tree has
224
no stat facility, or need for a stat cache feedback during commit,
225
it may return None for the second element of the tuple.
227
return (self.get_file(file_id, path), None)
221
def has_changes(self, _from_tree=None):
222
"""Quickly check that the tree contains at least one commitable change.
224
:param _from_tree: tree to compare against to find changes (default to
225
the basis tree and is intended to be used by tests).
227
:return: True if a change is found. False otherwise
229
# Check pending merges
230
if len(self.get_parent_ids()) > 1:
232
if _from_tree is None:
233
_from_tree = self.basis_tree()
234
changes = self.iter_changes(_from_tree)
236
change = changes.next()
237
# Exclude root (talk about black magic... --vila 20090629)
238
if change[4] == (None, None):
239
change = changes.next()
241
except StopIteration:
246
def check_changed_or_out_of_date(self, strict, opt_name,
247
more_error, more_warning):
248
"""Check the tree for uncommitted changes and branch synchronization.
250
If strict is None and not set in the config files, a warning is issued.
251
If strict is True, an error is raised.
252
If strict is False, no checks are done and no warning is issued.
254
:param strict: True, False or None, searched in branch config if None.
256
:param opt_name: strict option name to search in config file.
258
:param more_error: Details about how to avoid the check.
260
:param more_warning: Details about what is happening.
263
strict = self.branch.get_config_stack().get(opt_name)
264
if strict is not False:
266
if (self.has_changes()):
267
err_class = errors.UncommittedChanges
268
elif self.last_revision() != self.branch.last_revision():
269
# The tree has lost sync with its branch, there is little
270
# chance that the user is aware of it but he can still force
271
# the action with --no-strict
272
err_class = errors.OutOfDateTree
273
if err_class is not None:
275
err = err_class(self, more=more_warning)
276
# We don't want to interrupt the user if he expressed no
277
# preference about strict.
278
trace.warning('%s', err._format())
280
err = err_class(self, more=more_error)
230
284
def last_revision(self):
341
392
of added files, and ignored_files is a dict mapping files that were
342
393
ignored to the rule that caused them to be ignored.
344
# not in an inner loop; and we want to remove direct use of this,
345
# so here as a reminder for now. RBC 20070703
346
from bzrlib.inventory import InventoryEntry
348
action = add.AddAction()
351
# no paths supplied: add the entire tree.
353
# mutter("smart add of %r")
395
raise NotImplementedError(self.smart_add)
398
class MutableInventoryTree(MutableTree, tree.InventoryTree):
400
@needs_tree_write_lock
401
def apply_inventory_delta(self, changes):
402
"""Apply changes to the inventory as an atomic operation.
404
:param changes: An inventory delta to apply to the working tree's
407
:seealso Inventory.apply_delta: For details on the changes parameter.
354
410
inv = self.inventory
360
# validate user file paths and convert all paths to tree
361
# relative : it's cheaper to make a tree relative path an abspath
362
# than to convert an abspath to tree relative, and it's cheaper to
363
# perform the canonicalization in bulk.
364
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
365
rf = _FastPath(filepath)
366
# validate user parameters. Our recursive code avoids adding new files
367
# that need such validation
368
if self.is_control_filename(rf.raw_path):
369
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
371
abspath = self.abspath(rf.raw_path)
372
kind = osutils.file_kind(abspath)
373
if kind == 'directory':
374
# schedule the dir for scanning
377
if not InventoryEntry.versionable_kind(kind):
378
raise errors.BadFileKindError(filename=abspath, kind=kind)
379
# ensure the named path is added, so that ignore rules in the later directory
381
# we dont have a parent ie known yet.: use the relatively slower inventory
383
versioned = inv.has_filename(rf.raw_path)
386
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
389
# no need to walk any directories at all.
390
if len(added) > 0 and save:
391
self._write_inventory(inv)
392
return added, ignored
394
# only walk the minimal parents needed: we have user_dirs to override
398
is_inside = osutils.is_inside_or_parent_of_any
399
for path in sorted(user_dirs):
400
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
401
dirs_to_add.append((path, None))
402
prev_dir = path.raw_path
404
# dirs_to_add is initialised to a list of directories, but as we scan
405
# directories we append files to it.
406
# XXX: We should determine kind of files when we scan them rather than
407
# adding to this list. RBC 20070703
408
for directory, parent_ie in dirs_to_add:
409
# directory is tree-relative
410
abspath = self.abspath(directory.raw_path)
412
# get the contents of this directory.
414
# find the kind of the path being added.
415
kind = osutils.file_kind(abspath)
417
if not InventoryEntry.versionable_kind(kind):
418
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
421
if parent_ie is not None:
422
versioned = directory.base_path in parent_ie.children
424
# without the parent ie, use the relatively slower inventory
426
versioned = inv.has_filename(
427
self._fix_case_of_inventory_path(directory.raw_path))
429
if kind == 'directory':
431
sub_branch = bzrdir.BzrDir.open(abspath)
433
except errors.NotBranchError:
435
except errors.UnsupportedFormatError:
440
if directory.raw_path == '':
441
# mutter("tree root doesn't need to be added")
445
# mutter("%r is already versioned", abspath)
447
# XXX: This is wrong; people *might* reasonably be trying to add
448
# subtrees as subtrees. This should probably only be done in formats
449
# which can represent subtrees, and even then perhaps only when
450
# the user asked to add subtrees. At the moment you can add them
451
# specially through 'join --reference', which is perhaps
452
# reasonable: adding a new reference is a special operation and
453
# can have a special behaviour. mbp 20070306
454
mutter("%r is a nested bzr tree", abspath)
456
_add_one(self, inv, parent_ie, directory, kind, action)
457
added.append(directory.raw_path)
459
if kind == 'directory' and not sub_tree:
460
if parent_ie is not None:
462
this_ie = parent_ie.children[directory.base_path]
464
# without the parent ie, use the relatively slower inventory
466
this_id = inv.path2id(
467
self._fix_case_of_inventory_path(directory.raw_path))
471
this_ie = inv[this_id]
473
for subf in sorted(os.listdir(abspath)):
474
# here we could use TreeDirectory rather than
475
# string concatenation.
476
subp = osutils.pathjoin(directory.raw_path, subf)
477
# TODO: is_control_filename is very slow. Make it faster.
478
# TreeDirectory.is_control_filename could also make this
479
# faster - its impossible for a non root dir to have a
481
if self.is_control_filename(subp):
482
mutter("skip control directory %r", subp)
483
elif subf in this_ie.children:
484
# recurse into this already versioned subdir.
485
dirs_to_add.append((_FastPath(subp, subf), this_ie))
487
# user selection overrides ignoes
488
# ignore while selecting files - if we globbed in the
489
# outer loop we would ignore user files.
490
ignore_glob = self.is_ignored(subp)
491
if ignore_glob is not None:
492
# mutter("skip ignored sub-file %r", subp)
493
ignored.setdefault(ignore_glob, []).append(subp)
495
#mutter("queue to add sub-file %r", subp)
496
dirs_to_add.append((_FastPath(subp, subf), this_ie))
500
self._write_inventory(inv)
502
self.read_working_inventory()
503
return added, ignored
411
inv.apply_delta(changes)
412
self._write_inventory(inv)
414
def _fix_case_of_inventory_path(self, path):
415
"""If our tree isn't case sensitive, return the canonical path"""
416
if not self.case_sensitive:
417
path = self.get_canonical_inventory_path(path)
420
@needs_tree_write_lock
421
def smart_add(self, file_list, recurse=True, action=None, save=True):
422
"""Version file_list, optionally recursing into directories.
424
This is designed more towards DWIM for humans than API clarity.
425
For the specific behaviour see the help for cmd_add().
427
:param file_list: List of zero or more paths. *NB: these are
428
interpreted relative to the process cwd, not relative to the
429
tree.* (Add and most other tree methods use tree-relative
431
:param action: A reporter to be called with the inventory, parent_ie,
432
path and kind of the path being added. It may return a file_id if
433
a specific one should be used.
434
:param save: Save the inventory after completing the adds. If False
435
this provides dry-run functionality by doing the add and not saving
437
:return: A tuple - files_added, ignored_files. files_added is the count
438
of added files, and ignored_files is a dict mapping files that were
439
ignored to the rule that caused them to be ignored.
441
# Not all mutable trees can have conflicts
442
if getattr(self, 'conflicts', None) is not None:
443
# Collect all related files without checking whether they exist or
444
# are versioned. It's cheaper to do that once for all conflicts
445
# than trying to find the relevant conflict for each added file.
446
conflicts_related = set()
447
for c in self.conflicts():
448
conflicts_related.update(c.associated_filenames())
450
conflicts_related = None
451
adder = _SmartAddHelper(self, action, conflicts_related)
452
adder.add(file_list, recurse=recurse)
454
invdelta = adder.get_inventory_delta()
455
self.apply_inventory_delta(invdelta)
456
return adder.added, adder.ignored
505
458
def update_basis_by_delta(self, new_revid, delta):
506
459
"""Update the parents of this tree after a commit.
548
508
"""Create the default hooks.
551
hooks.Hooks.__init__(self)
552
# Invoked before a commit is done in a tree. New in 1.4
553
self['start_commit'] = []
511
hooks.Hooks.__init__(self, "bzrlib.mutabletree", "MutableTree.hooks")
512
self.add_hook('start_commit',
513
"Called before a commit is performed on a tree. The start commit "
514
"hook is able to change the tree before the commit takes place. "
515
"start_commit is called with the bzrlib.mutabletree.MutableTree "
516
"that the commit is being performed on.", (1, 4))
517
self.add_hook('post_commit',
518
"Called after a commit is performed on a tree. The hook is "
519
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
520
"The mutable tree the commit was performed on is available via "
521
"the mutable_tree attribute of that object.", (2, 0))
556
524
# install the default hooks into the MutableTree class.
557
525
MutableTree.hooks = MutableTreeHooks()
560
class _FastPath(object):
561
"""A path object with fast accessors for things like basename."""
563
__slots__ = ['raw_path', 'base_path']
565
def __init__(self, path, base_path=None):
566
"""Construct a FastPath from path."""
567
if base_path is None:
568
self.base_path = osutils.basename(path)
570
self.base_path = base_path
573
def __cmp__(self, other):
574
return cmp(self.raw_path, other.raw_path)
577
return hash(self.raw_path)
580
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
581
"""Add a new entry to the inventory and automatically add unversioned parents.
583
:param inv: Inventory which will receive the new entry.
584
:param parent_ie: Parent inventory entry if known, or None. If
585
None, the parent is looked up by name and used if present, otherwise it
586
is recursively added.
587
:param kind: Kind of new entry (file, directory, etc)
588
:param action: callback(inv, parent_ie, path, kind); return ignored.
589
:return: A list of paths which have been added.
591
# Nothing to do if path is already versioned.
592
# This is safe from infinite recursion because the tree root is
594
if parent_ie is not None:
595
# we have a parent ie already
598
# slower but does not need parent_ie
599
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
601
# its really not there : add the parent
602
# note that the dirname use leads to some extra str copying etc but as
603
# there are a limited number of dirs we can be nested under, it should
604
# generally find it very fast and not recurse after that.
605
added = _add_one_and_parent(tree, inv, None,
606
_FastPath(dirname(path.raw_path)), 'directory', action)
607
parent_id = inv.path2id(dirname(path.raw_path))
608
parent_ie = inv[parent_id]
609
_add_one(tree, inv, parent_ie, path, kind, action)
610
return added + [path.raw_path]
613
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
614
"""Add a new entry to the inventory.
616
:param inv: Inventory which will receive the new entry.
617
:param parent_ie: Parent inventory entry.
618
:param kind: Kind of new entry (file, directory, etc)
619
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
620
file_id or None to generate a new file id
623
file_id = file_id_callback(inv, parent_ie, path, kind)
624
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
528
class PostCommitHookParams(object):
529
"""Parameters for the post_commit hook.
531
To access the parameters, use the following attributes:
533
* mutable_tree - the MutableTree object
536
def __init__(self, mutable_tree):
537
"""Create the parameters for the post_commit hook."""
538
self.mutable_tree = mutable_tree
541
class _SmartAddHelper(object):
542
"""Helper for MutableTree.smart_add."""
544
def get_inventory_delta(self):
545
return self._invdelta.values()
547
def _get_ie(self, inv_path):
548
"""Retrieve the most up to date inventory entry for a path.
550
:param inv_path: Normalized inventory path
551
:return: Inventory entry (with possibly invalid .children for
554
entry = self._invdelta.get(inv_path)
555
if entry is not None:
557
# Find a 'best fit' match if the filesystem is case-insensitive
558
inv_path = self.tree._fix_case_of_inventory_path(inv_path)
559
file_id = self.tree.path2id(inv_path)
560
if file_id is not None:
561
return self.tree.iter_entries_by_dir([file_id]).next()[1]
564
def _convert_to_directory(self, this_ie, inv_path):
565
"""Convert an entry to a directory.
567
:param this_ie: Inventory entry
568
:param inv_path: Normalized path for the inventory entry
569
:return: The new inventory entry
571
# Same as in _add_one below, if the inventory doesn't
572
# think this is a directory, update the inventory
573
this_ie = _mod_inventory.InventoryDirectory(
574
this_ie.file_id, this_ie.name, this_ie.parent_id)
575
self._invdelta[inv_path] = (inv_path, inv_path, this_ie.file_id,
579
def _add_one_and_parent(self, parent_ie, path, kind, inv_path):
580
"""Add a new entry to the inventory and automatically add unversioned parents.
582
:param parent_ie: Parent inventory entry if known, or None. If
583
None, the parent is looked up by name and used if present, otherwise it
584
is recursively added.
586
:param kind: Kind of new entry (file, directory, etc)
588
:return: Inventory entry for path and a list of paths which have been added.
590
# Nothing to do if path is already versioned.
591
# This is safe from infinite recursion because the tree root is
593
inv_dirname = osutils.dirname(inv_path)
594
dirname, basename = osutils.split(path)
595
if parent_ie is None:
596
# slower but does not need parent_ie
597
this_ie = self._get_ie(inv_path)
598
if this_ie is not None:
600
# its really not there : add the parent
601
# note that the dirname use leads to some extra str copying etc but as
602
# there are a limited number of dirs we can be nested under, it should
603
# generally find it very fast and not recurse after that.
604
parent_ie = self._add_one_and_parent(None,
605
dirname, 'directory',
607
# if the parent exists, but isn't a directory, we have to do the
608
# kind change now -- really the inventory shouldn't pretend to know
609
# the kind of wt files, but it does.
610
if parent_ie.kind != 'directory':
611
# nb: this relies on someone else checking that the path we're using
612
# doesn't contain symlinks.
613
parent_ie = self._convert_to_directory(parent_ie, inv_dirname)
614
file_id = self.action(self.tree.inventory, parent_ie, path, kind)
615
entry = _mod_inventory.make_entry(kind, basename, parent_ie.file_id,
617
self._invdelta[inv_path] = (None, inv_path, entry.file_id, entry)
618
self.added.append(inv_path)
621
def _gather_dirs_to_add(self, user_dirs):
622
# only walk the minimal parents needed: we have user_dirs to override
626
is_inside = osutils.is_inside_or_parent_of_any
627
for path, (inv_path, this_ie) in sorted(
628
user_dirs.iteritems(), key=operator.itemgetter(0)):
629
if (prev_dir is None or not is_inside([prev_dir], path)):
630
yield (path, inv_path, this_ie, None)
633
def __init__(self, tree, action, conflicts_related=None):
636
self.action = add.AddAction()
642
if conflicts_related is None:
643
self.conflicts_related = frozenset()
645
self.conflicts_related = conflicts_related
647
def add(self, file_list, recurse=True):
648
from bzrlib.inventory import InventoryEntry
650
# no paths supplied: add the entire tree.
651
# FIXME: this assumes we are running in a working tree subdir :-/
655
# expand any symlinks in the directory part, while leaving the
657
# only expanding if symlinks are supported avoids windows path bugs
658
if osutils.has_symlinks():
659
file_list = map(osutils.normalizepath, file_list)
662
# validate user file paths and convert all paths to tree
663
# relative : it's cheaper to make a tree relative path an abspath
664
# than to convert an abspath to tree relative, and it's cheaper to
665
# perform the canonicalization in bulk.
666
for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
667
# validate user parameters. Our recursive code avoids adding new
668
# files that need such validation
669
if self.tree.is_control_filename(filepath):
670
raise errors.ForbiddenControlFileError(filename=filepath)
672
abspath = self.tree.abspath(filepath)
673
kind = osutils.file_kind(abspath)
674
# ensure the named path is added, so that ignore rules in the later
675
# directory walk dont skip it.
676
# we dont have a parent ie known yet.: use the relatively slower
677
# inventory probing method
678
inv_path, _ = osutils.normalized_filename(filepath)
679
this_ie = self._get_ie(inv_path)
681
this_ie = self._add_one_and_parent(None, filepath, kind, inv_path)
682
if kind == 'directory':
683
# schedule the dir for scanning
684
user_dirs[filepath] = (inv_path, this_ie)
687
# no need to walk any directories at all.
690
things_to_add = list(self._gather_dirs_to_add(user_dirs))
692
illegalpath_re = re.compile(r'[\r\n]')
693
for directory, inv_path, this_ie, parent_ie in things_to_add:
694
# directory is tree-relative
695
abspath = self.tree.abspath(directory)
697
# get the contents of this directory.
699
# find the kind of the path being added, and save stat_value
703
stat_value = osutils.file_stat(abspath)
704
kind = osutils.file_kind_from_stat_mode(stat_value.st_mode)
708
# allow AddAction to skip this file
709
if self.action.skip_file(self.tree, abspath, kind, stat_value):
711
if not InventoryEntry.versionable_kind(kind):
712
trace.warning("skipping %s (can't add file of kind '%s')",
715
if illegalpath_re.search(directory):
716
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
718
if directory in self.conflicts_related:
719
# If the file looks like one generated for a conflict, don't
722
'skipping %s (generated to help resolve conflicts)',
726
if kind == 'directory' and directory != '':
728
transport = _mod_transport.get_transport_from_path(abspath)
729
controldir.ControlDirFormat.find_format(transport)
731
except errors.NotBranchError:
733
except errors.UnsupportedFormatError:
738
if this_ie is not None:
741
# XXX: This is wrong; people *might* reasonably be trying to
742
# add subtrees as subtrees. This should probably only be done
743
# in formats which can represent subtrees, and even then
744
# perhaps only when the user asked to add subtrees. At the
745
# moment you can add them specially through 'join --reference',
746
# which is perhaps reasonable: adding a new reference is a
747
# special operation and can have a special behaviour. mbp
749
trace.warning("skipping nested tree %r", abspath)
751
this_ie = self._add_one_and_parent(parent_ie, directory, kind,
754
if kind == 'directory' and not sub_tree:
755
if this_ie.kind != 'directory':
756
this_ie = self._convert_to_directory(this_ie, inv_path)
758
for subf in sorted(os.listdir(abspath)):
759
inv_f, _ = osutils.normalized_filename(subf)
760
# here we could use TreeDirectory rather than
761
# string concatenation.
762
subp = osutils.pathjoin(directory, subf)
763
# TODO: is_control_filename is very slow. Make it faster.
764
# TreeDirectory.is_control_filename could also make this
765
# faster - its impossible for a non root dir to have a
767
if self.tree.is_control_filename(subp):
768
trace.mutter("skip control directory %r", subp)
770
sub_invp = osutils.pathjoin(inv_path, inv_f)
771
entry = self._invdelta.get(sub_invp)
772
if entry is not None:
775
sub_ie = this_ie.children.get(inv_f)
776
if sub_ie is not None:
777
# recurse into this already versioned subdir.
778
things_to_add.append((subp, sub_invp, sub_ie, this_ie))
780
# user selection overrides ignores
781
# ignore while selecting files - if we globbed in the
782
# outer loop we would ignore user files.
783
ignore_glob = self.tree.is_ignored(subp)
784
if ignore_glob is not None:
785
self.ignored.setdefault(ignore_glob, []).append(subp)
787
things_to_add.append((subp, sub_invp, None, this_ie))
added
removed
bzrlib/mutabletree.py
