170
186
:seealso Inventory.apply_delta: For details on the changes parameter.
174
inv.apply_delta(changes)
175
self._write_inventory(inv)
188
raise NotImplementedError(self.apply_inventory_delta)
177
190
@needs_write_lock
178
191
def commit(self, message=None, revprops=None, *args,
180
193
# avoid circular imports
181
194
from bzrlib import commit
184
if not 'branch-nick' in revprops:
185
revprops['branch-nick'] = self.branch.nick
186
author = kwargs.pop('author', None)
187
if author is not None:
188
if 'author' in revprops:
189
# XXX: maybe we should just accept one of them?
190
raise AssertionError('author property given twice')
191
revprops['author'] = author
195
possible_master_transports=[]
196
revprops = commit.Commit.update_revprops(
199
kwargs.pop('authors', None),
200
kwargs.pop('author', None),
201
kwargs.get('local', False),
202
possible_master_transports)
192
203
# args for wt.commit start at message from the Commit.commit method,
193
204
args = (message, ) + args
194
205
for hook in MutableTree.hooks['start_commit']:
196
207
committed_id = commit.Commit().commit(working_tree=self,
197
revprops=revprops, *args, **kwargs)
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)
198
214
return committed_id
200
216
def _gather_kinds(self, files, kinds):
201
217
"""Helper function for add - sets the entries of kinds."""
202
218
raise NotImplementedError(self._gather_kinds)
204
def get_file_with_stat(self, file_id, path=None):
205
"""Get a file handle and stat object for file_id.
207
The default implementation returns (self.get_file, None) for backwards
210
:param file_id: The file id to read.
211
:param path: The path of the file, if it is known.
212
:return: A tuple (file_handle, stat_value_or_None). If the tree has
213
no stat facility, or need for a stat cache feedback during commit,
214
it may return None for the second element of the tuple.
216
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().get_user_option_as_bool(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)
219
284
def last_revision(self):
324
392
of added files, and ignored_files is a dict mapping files that were
325
393
ignored to the rule that caused them to be ignored.
327
# not in an inner loop; and we want to remove direct use of this,
328
# so here as a reminder for now. RBC 20070703
329
from bzrlib.inventory import InventoryEntry
331
action = add.AddAction()
334
# no paths supplied: add the entire tree.
336
# 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.
337
410
inv = self.inventory
343
# validate user file paths and convert all paths to tree
344
# relative : it's cheaper to make a tree relative path an abspath
345
# than to convert an abspath to tree relative.
346
for filepath in file_list:
347
rf = _FastPath(self.relpath(filepath))
348
# validate user parameters. Our recursive code avoids adding new files
349
# that need such validation
350
if self.is_control_filename(rf.raw_path):
351
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
353
abspath = self.abspath(rf.raw_path)
354
kind = osutils.file_kind(abspath)
355
if kind == 'directory':
356
# schedule the dir for scanning
359
if not InventoryEntry.versionable_kind(kind):
360
raise errors.BadFileKindError(filename=abspath, kind=kind)
361
# ensure the named path is added, so that ignore rules in the later directory
363
# we dont have a parent ie known yet.: use the relatively slower inventory
365
versioned = inv.has_filename(rf.raw_path)
368
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
371
# no need to walk any directories at all.
372
if len(added) > 0 and save:
373
self._write_inventory(inv)
374
return added, ignored
376
# only walk the minimal parents needed: we have user_dirs to override
380
is_inside = osutils.is_inside_or_parent_of_any
381
for path in sorted(user_dirs):
382
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
383
dirs_to_add.append((path, None))
384
prev_dir = path.raw_path
386
# dirs_to_add is initialised to a list of directories, but as we scan
387
# directories we append files to it.
388
# XXX: We should determine kind of files when we scan them rather than
389
# adding to this list. RBC 20070703
390
for directory, parent_ie in dirs_to_add:
391
# directory is tree-relative
392
abspath = self.abspath(directory.raw_path)
394
# get the contents of this directory.
396
# find the kind of the path being added.
397
kind = osutils.file_kind(abspath)
399
if not InventoryEntry.versionable_kind(kind):
400
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
403
if parent_ie is not None:
404
versioned = directory.base_path in parent_ie.children
406
# without the parent ie, use the relatively slower inventory
408
versioned = inv.has_filename(directory.raw_path)
410
if kind == 'directory':
412
sub_branch = bzrdir.BzrDir.open(abspath)
414
except errors.NotBranchError:
416
except errors.UnsupportedFormatError:
421
if directory.raw_path == '':
422
# mutter("tree root doesn't need to be added")
426
# mutter("%r is already versioned", abspath)
428
# XXX: This is wrong; people *might* reasonably be trying to add
429
# subtrees as subtrees. This should probably only be done in formats
430
# which can represent subtrees, and even then perhaps only when
431
# the user asked to add subtrees. At the moment you can add them
432
# specially through 'join --reference', which is perhaps
433
# reasonable: adding a new reference is a special operation and
434
# can have a special behaviour. mbp 20070306
435
mutter("%r is a nested bzr tree", abspath)
437
_add_one(self, inv, parent_ie, directory, kind, action)
438
added.append(directory.raw_path)
440
if kind == 'directory' and not sub_tree:
441
if parent_ie is not None:
443
this_ie = parent_ie.children[directory.base_path]
445
# without the parent ie, use the relatively slower inventory
447
this_id = inv.path2id(directory.raw_path)
451
this_ie = inv[this_id]
453
for subf in sorted(os.listdir(abspath)):
454
# here we could use TreeDirectory rather than
455
# string concatenation.
456
subp = osutils.pathjoin(directory.raw_path, subf)
457
# TODO: is_control_filename is very slow. Make it faster.
458
# TreeDirectory.is_control_filename could also make this
459
# faster - its impossible for a non root dir to have a
461
if self.is_control_filename(subp):
462
mutter("skip control directory %r", subp)
463
elif subf in this_ie.children:
464
# recurse into this already versioned subdir.
465
dirs_to_add.append((_FastPath(subp, subf), this_ie))
467
# user selection overrides ignoes
468
# ignore while selecting files - if we globbed in the
469
# outer loop we would ignore user files.
470
ignore_glob = self.is_ignored(subp)
471
if ignore_glob is not None:
472
# mutter("skip ignored sub-file %r", subp)
473
ignored.setdefault(ignore_glob, []).append(subp)
475
#mutter("queue to add sub-file %r", subp)
476
dirs_to_add.append((_FastPath(subp, subf), this_ie))
480
self._write_inventory(inv)
482
self.read_working_inventory()
483
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
485
458
def update_basis_by_delta(self, new_revid, delta):
486
459
"""Update the parents of this tree after a commit.
528
508
"""Create the default hooks.
531
hooks.Hooks.__init__(self)
532
# Invoked before a commit is done in a tree. New in 1.4
533
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))
536
524
# install the default hooks into the MutableTree class.
537
525
MutableTree.hooks = MutableTreeHooks()
540
class _FastPath(object):
541
"""A path object with fast accessors for things like basename."""
543
__slots__ = ['raw_path', 'base_path']
545
def __init__(self, path, base_path=None):
546
"""Construct a FastPath from path."""
547
if base_path is None:
548
self.base_path = osutils.basename(path)
550
self.base_path = base_path
553
def __cmp__(self, other):
554
return cmp(self.raw_path, other.raw_path)
557
return hash(self.raw_path)
560
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
561
"""Add a new entry to the inventory and automatically add unversioned parents.
563
:param inv: Inventory which will receive the new entry.
564
:param parent_ie: Parent inventory entry if known, or None. If
565
None, the parent is looked up by name and used if present, otherwise it
566
is recursively added.
567
:param kind: Kind of new entry (file, directory, etc)
568
:param action: callback(inv, parent_ie, path, kind); return ignored.
569
:return: A list of paths which have been added.
571
# Nothing to do if path is already versioned.
572
# This is safe from infinite recursion because the tree root is
574
if parent_ie is not None:
575
# we have a parent ie already
578
# slower but does not need parent_ie
579
if inv.has_filename(path.raw_path):
581
# its really not there : add the parent
582
# note that the dirname use leads to some extra str copying etc but as
583
# there are a limited number of dirs we can be nested under, it should
584
# generally find it very fast and not recurse after that.
585
added = _add_one_and_parent(tree, inv, None,
586
_FastPath(dirname(path.raw_path)), 'directory', action)
587
parent_id = inv.path2id(dirname(path.raw_path))
588
parent_ie = inv[parent_id]
589
_add_one(tree, inv, parent_ie, path, kind, action)
590
return added + [path.raw_path]
593
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
594
"""Add a new entry to the inventory.
596
:param inv: Inventory which will receive the new entry.
597
:param parent_ie: Parent inventory entry.
598
:param kind: Kind of new entry (file, directory, etc)
599
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
600
file_id or None to generate a new file id
603
file_id = file_id_callback(inv, parent_ie, path, kind)
604
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.
585
:param kind: Kind of new entry (file, directory, etc)
586
:param action: callback(tree, parent_ie, path, kind); can return file_id
587
:return: Inventory entry for path and a list of paths which have been added.
589
# Nothing to do if path is already versioned.
590
# This is safe from infinite recursion because the tree root is
592
inv_dirname = osutils.dirname(inv_path)
593
dirname, basename = osutils.split(path)
594
if parent_ie is None:
595
# slower but does not need parent_ie
596
this_ie = self._get_ie(inv_path)
597
if this_ie is not None:
599
# its really not there : add the parent
600
# note that the dirname use leads to some extra str copying etc but as
601
# there are a limited number of dirs we can be nested under, it should
602
# generally find it very fast and not recurse after that.
603
parent_ie = self._add_one_and_parent(None,
604
dirname, 'directory',
606
# if the parent exists, but isn't a directory, we have to do the
607
# kind change now -- really the inventory shouldn't pretend to know
608
# the kind of wt files, but it does.
609
if parent_ie.kind != 'directory':
610
# nb: this relies on someone else checking that the path we're using
611
# doesn't contain symlinks.
612
parent_ie = self._convert_to_directory(parent_ie, inv_dirname)
613
file_id = self.action(self.tree.inventory, parent_ie, path, kind)
614
entry = _mod_inventory.make_entry(kind, basename, parent_ie.file_id,
616
self._invdelta[inv_path] = (None, inv_path, entry.file_id, entry)
617
self.added.append(inv_path)
620
def _gather_dirs_to_add(self, user_dirs):
621
# only walk the minimal parents needed: we have user_dirs to override
625
is_inside = osutils.is_inside_or_parent_of_any
626
for path, (inv_path, this_ie) in sorted(
627
user_dirs.iteritems(), key=operator.itemgetter(0)):
628
if (prev_dir is None or not is_inside([prev_dir], path)):
629
yield (path, inv_path, this_ie, None)
632
def __init__(self, tree, action, conflicts_related=None):
635
self.action = add.AddAction()
641
if conflicts_related is None:
642
self.conflicts_related = frozenset()
644
self.conflicts_related = conflicts_related
646
def add(self, file_list, recurse=True):
647
from bzrlib.inventory import InventoryEntry
649
# no paths supplied: add the entire tree.
650
# FIXME: this assumes we are running in a working tree subdir :-/
654
# expand any symlinks in the directory part, while leaving the
656
# only expanding if symlinks are supported avoids windows path bugs
657
if osutils.has_symlinks():
658
file_list = map(osutils.normalizepath, file_list)
661
# validate user file paths and convert all paths to tree
662
# relative : it's cheaper to make a tree relative path an abspath
663
# than to convert an abspath to tree relative, and it's cheaper to
664
# perform the canonicalization in bulk.
665
for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
666
# validate user parameters. Our recursive code avoids adding new
667
# files that need such validation
668
if self.tree.is_control_filename(filepath):
669
raise errors.ForbiddenControlFileError(filename=filepath)
671
abspath = self.tree.abspath(filepath)
672
kind = osutils.file_kind(abspath)
673
# ensure the named path is added, so that ignore rules in the later
674
# directory walk dont skip it.
675
# we dont have a parent ie known yet.: use the relatively slower
676
# inventory probing method
677
inv_path, _ = osutils.normalized_filename(filepath)
678
this_ie = self._get_ie(inv_path)
680
this_ie = self._add_one_and_parent(None, filepath, kind, inv_path)
681
if kind == 'directory':
682
# schedule the dir for scanning
683
user_dirs[filepath] = (inv_path, this_ie)
686
# no need to walk any directories at all.
689
things_to_add = list(self._gather_dirs_to_add(user_dirs))
691
illegalpath_re = re.compile(r'[\r\n]')
692
for directory, inv_path, this_ie, parent_ie in things_to_add:
693
# directory is tree-relative
694
abspath = self.tree.abspath(directory)
696
# get the contents of this directory.
698
# find the kind of the path being added.
700
kind = osutils.file_kind(abspath)
704
if not InventoryEntry.versionable_kind(kind):
705
trace.warning("skipping %s (can't add file of kind '%s')",
708
if illegalpath_re.search(directory):
709
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
711
if directory in self.conflicts_related:
712
# If the file looks like one generated for a conflict, don't
715
'skipping %s (generated to help resolve conflicts)',
719
if kind == 'directory' and directory != '':
721
transport = _mod_transport.get_transport_from_path(abspath)
722
controldir.ControlDirFormat.find_format(transport)
724
except errors.NotBranchError:
726
except errors.UnsupportedFormatError:
731
if this_ie is not None:
734
# XXX: This is wrong; people *might* reasonably be trying to
735
# add subtrees as subtrees. This should probably only be done
736
# in formats which can represent subtrees, and even then
737
# perhaps only when the user asked to add subtrees. At the
738
# moment you can add them specially through 'join --reference',
739
# which is perhaps reasonable: adding a new reference is a
740
# special operation and can have a special behaviour. mbp
742
trace.mutter("%r is a nested bzr tree", abspath)
744
this_ie = self._add_one_and_parent(parent_ie, directory, kind, inv_path)
746
if kind == 'directory' and not sub_tree:
747
if this_ie.kind != 'directory':
748
this_ie = self._convert_to_directory(this_ie, inv_path)
750
for subf in sorted(os.listdir(abspath)):
751
inv_f, _ = osutils.normalized_filename(subf)
752
# here we could use TreeDirectory rather than
753
# string concatenation.
754
subp = osutils.pathjoin(directory, subf)
755
# TODO: is_control_filename is very slow. Make it faster.
756
# TreeDirectory.is_control_filename could also make this
757
# faster - its impossible for a non root dir to have a
759
if self.tree.is_control_filename(subp):
760
trace.mutter("skip control directory %r", subp)
762
sub_invp = osutils.pathjoin(inv_path, inv_f)
763
entry = self._invdelta.get(sub_invp)
764
if entry is not None:
767
sub_ie = this_ie.children.get(inv_f)
768
if sub_ie is not None:
769
# recurse into this already versioned subdir.
770
things_to_add.append((subp, sub_invp, sub_ie, this_ie))
772
# user selection overrides ignoes
773
# ignore while selecting files - if we globbed in the
774
# outer loop we would ignore user files.
775
ignore_glob = self.tree.is_ignored(subp)
776
if ignore_glob is not None:
777
self.ignored.setdefault(ignore_glob, []).append(subp)
779
things_to_add.append((subp, sub_invp, None, this_ie))
added
removed
bzrlib/mutabletree.py
