292
259
self._check_bound_branch()
294
261
# Check that the working tree is up to date
295
old_revno, new_revno = self._check_out_of_date_tree()
262
old_revno,new_revno = self._check_out_of_date_tree()
297
# Complete configuration setup
298
if reporter is not None:
299
self.reporter = reporter
300
elif self.reporter is None:
301
self.reporter = self._select_reporter()
265
# raise an exception as soon as we find a single unknown.
266
for unknown in self.work_tree.unknowns():
267
raise StrictCommitFailed()
302
269
if self.config is None:
303
270
self.config = self.branch.get_config()
305
# If provided, ensure the specified files are versioned
306
if self.specific_files is not None:
307
# Note: This routine is being called because it raises
308
# PathNotVersionedError as a side effect of finding the IDs. We
309
# later use the ids we found as input to the working tree
310
# inventory iterator, so we only consider those ids rather than
311
# examining the whole tree again.
272
self.work_inv = self.work_tree.inventory
273
self.basis_inv = self.basis_tree.inventory
274
if specific_files is not None:
275
# Ensure specified files are versioned
276
# (We don't actually need the ids here)
312
277
# XXX: Dont we have filter_unversioned to do this more
314
self.specific_file_ids = tree.find_ids_across_trees(
315
specific_files, [self.basis_tree, self.work_tree])
317
# Setup the progress bar. As the number of files that need to be
318
# committed in unknown, progress is reported as stages.
319
# We keep track of entries separately though and include that
320
# information in the progress bar during the relevant stages.
321
self.pb_stage_name = ""
322
self.pb_stage_count = 0
323
self.pb_stage_total = 5
324
if self.bound_branch:
325
self.pb_stage_total += 1
326
self.pb.show_pct = False
327
self.pb.show_spinner = False
328
self.pb.show_eta = False
329
self.pb.show_count = True
330
self.pb.show_bar = True
332
# After a merge, a selected file commit is not supported.
333
# See 'bzr help merge' for an explanation as to why.
334
self.basis_inv = self.basis_tree.inventory
279
tree.find_ids_across_trees(specific_files,
280
[self.basis_tree, self.work_tree])
282
# Setup the progress bar ...
283
# one to finish, one for rev and inventory, and one for each
284
# inventory entry, and the same for the new inventory.
285
# note that this estimate is too long when we do a partial tree
286
# commit which excludes some new files from being considered.
287
# The estimate is corrected when we populate the new inv.
288
self.pb_total = len(self.work_inv) + 5
335
291
self._gather_parents()
336
292
if len(self.parents) > 1 and self.specific_files:
337
293
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
339
# Collect the changes
340
self._set_progress_stage("Collecting changes",
341
entries_title="Directory")
295
# Build the new inventory
342
296
self.builder = self.branch.get_commit_builder(self.parents,
343
297
self.config, timestamp, timezone, committer, revprops, rev_id)
298
self._remove_deleted()
299
self._populate_new_inv()
300
self._report_deletes()
301
self._check_pointless()
302
self._emit_progress_update()
304
# TODO: Now the new inventory is known, check for conflicts and
305
# prompt the user for a commit message.
306
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
307
# weave lines, because nothing should be recorded until it is known
308
# that commit will succeed.
309
self.builder.finish_inventory()
310
self._emit_progress_update()
311
message = message_callback(self)
312
assert isinstance(message, unicode), type(message)
313
self.message = message
314
self._escape_commit_message()
316
# Add revision data to the local branch
317
self.rev_id = self.builder.commit(self.message)
318
self._emit_progress_update()
346
# find the location being committed to
347
if self.bound_branch:
348
master_location = self.master_branch.base
350
master_location = self.branch.base
352
# report the start of the commit
353
self.reporter.started(new_revno, self.rev_id, master_location)
355
self._update_builder_with_changes()
356
self._report_and_accumulate_deletes()
357
self._check_pointless()
359
# TODO: Now the new inventory is known, check for conflicts.
360
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
361
# weave lines, because nothing should be recorded until it is known
362
# that commit will succeed.
363
self._set_progress_stage("Saving data locally")
364
self.builder.finish_inventory()
366
# Prompt the user for a commit message if none provided
367
message = message_callback(self)
368
assert isinstance(message, unicode), type(message)
369
self.message = message
370
self._escape_commit_message()
372
# Add revision data to the local branch
373
self.rev_id = self.builder.commit(self.message)
379
self._process_pre_hooks(old_revno, new_revno)
381
# Upload revision data to the master.
320
# upload revision data to the master.
382
321
# this will propagate merged revisions too if needed.
383
322
if self.bound_branch:
384
if not self.master_branch.repository.has_same_location(
385
self.branch.repository):
386
self._set_progress_stage("Uploading data to master branch")
387
self.master_branch.repository.fetch(self.branch.repository,
388
revision_id=self.rev_id)
323
self.master_branch.repository.fetch(self.branch.repository,
324
revision_id=self.rev_id)
389
325
# now the master has the revision data
390
326
# 'commit' to the master first so a timeout here causes the
391
327
# local branch to be out of date
633
563
mutter('commit parent ghost revision {%s}', revision)
635
def _update_builder_with_changes(self):
636
"""Update the commit builder with the data about what has changed.
638
# Build the revision inventory.
640
# This starts by creating a new empty inventory. Depending on
641
# which files are selected for commit, and what is present in the
642
# current tree, the new inventory is populated. inventory entries
643
# which are candidates for modification have their revision set to
644
# None; inventory entries that are carried over untouched have their
645
# revision set to their prior value.
565
def _remove_deleted(self):
566
"""Remove deleted files from the working inventories.
568
This is done prior to taking the working inventory as the
569
basis for the new committed inventory.
571
This returns true if any files
572
*that existed in the basis inventory* were deleted.
573
Files that were added and deleted
574
in the working copy don't matter.
576
specific = self.specific_files
578
deleted_paths = set()
579
for path, ie in self.work_inv.iter_entries():
580
if is_inside_any(deleted_paths, path):
581
# The tree will delete the required ids recursively.
583
if specific and not is_inside_any(specific, path):
585
if not self.work_tree.has_filename(path):
586
deleted_paths.add(path)
587
self.reporter.missing(path)
588
deleted_ids.append(ie.file_id)
589
self.work_tree.unversion(deleted_ids)
591
def _populate_new_inv(self):
592
"""Build revision inventory.
594
This creates a new empty inventory. Depending on
595
which files are selected for commit, and what is present in the
596
current tree, the new inventory is populated. inventory entries
597
which are candidates for modification have their revision set to
598
None; inventory entries that are carried over untouched have their
599
revision set to their prior value.
647
601
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
648
602
# results to create a new inventory at the same time, which results
649
603
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
650
604
# ADHB 11-07-2006
652
specific_files = self.specific_files
653
mutter("Selecting files for commit with filter %s", specific_files)
655
# Build the new inventory
656
self._populate_from_inventory(specific_files)
658
# If specific files are selected, then all un-selected files must be
659
# recorded in their previous state. For more details, see
660
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
662
for path, old_ie in self.basis_inv.iter_entries():
663
if old_ie.file_id in self.builder.new_inventory:
664
# already added - skip.
666
if is_inside_any(specific_files, path):
667
# was inside the selected path, if not present it has been
670
if old_ie.kind == 'directory':
671
self._next_progress_entry()
672
# not in final inv yet, was not in the selected files, so is an
673
# entry to be preserved unaltered.
675
# Note: specific file commits after a merge are currently
676
# prohibited. This test is for sanity/safety in case it's
677
# required after that changes.
678
if len(self.parents) > 1:
605
mutter("Selecting files for commit with filter %s", self.specific_files)
606
assert self.work_inv.root is not None
607
entries = self.work_inv.iter_entries()
608
if not self.builder.record_root_entry:
609
symbol_versioning.warn('CommitBuilders should support recording'
610
' the root entry as of bzr 0.10.', DeprecationWarning,
612
self.builder.new_inventory.add(self.basis_inv.root.copy())
614
self._emit_progress_update()
615
for path, new_ie in entries:
616
self._emit_progress_update()
617
file_id = new_ie.file_id
619
kind = self.work_tree.kind(file_id)
620
if kind == 'tree-reference' and self.recursive == 'down':
621
# nested tree: commit in it
622
sub_tree = WorkingTree.open(self.work_tree.abspath(path))
623
# FIXME: be more comprehensive here:
624
# this works when both trees are in --trees repository,
625
# but when both are bound to a different repository,
626
# it fails; a better way of approaching this is to
627
# finally implement the explicit-caches approach design
628
# a while back - RBC 20070306.
629
if (sub_tree.branch.repository.bzrdir.root_transport.base
631
self.work_tree.branch.repository.bzrdir.root_transport.base):
632
sub_tree.branch.repository = \
633
self.work_tree.branch.repository
635
sub_tree.commit(message=None, revprops=self.revprops,
636
recursive=self.recursive,
637
message_callback=self.message_callback,
638
timestamp=self.timestamp, timezone=self.timezone,
639
committer=self.committer,
640
allow_pointless=self.allow_pointless,
641
strict=self.strict, verbose=self.verbose,
642
local=self.local, reporter=self.reporter)
643
except errors.PointlessCommit:
645
if kind != new_ie.kind:
646
new_ie = inventory.make_entry(kind, new_ie.name,
647
new_ie.parent_id, file_id)
648
except errors.NoSuchFile:
650
# mutter('check %s {%s}', path, file_id)
651
if (not self.specific_files or
652
is_inside_or_parent_of_any(self.specific_files, path)):
653
# mutter('%s selected for commit', path)
679
655
ie.revision = None
680
delta, version_recorded = self.builder.record_entry_contents(
681
ie, self.parent_invs, path, self.basis_tree, None)
683
self.any_entries_changed = True
684
if delta: self._basis_delta.append(delta)
686
def _report_and_accumulate_deletes(self):
687
# XXX: Could the list of deleted paths and ids be instead taken from
688
# _populate_from_inventory?
689
deleted_ids = set(self.basis_inv._byid.keys()) - \
690
set(self.builder.new_inventory._byid.keys())
692
self.any_entries_deleted = True
693
deleted = [(self.basis_tree.id2path(file_id), file_id)
694
for file_id in deleted_ids]
696
# XXX: this is not quite directory-order sorting
697
for path, file_id in deleted:
698
self._basis_delta.append((path, None, file_id, None))
657
# mutter('%s not selected for commit', path)
658
if self.basis_inv.has_id(file_id):
659
ie = self.basis_inv[file_id].copy()
661
# this entry is new and not being committed
663
self.builder.record_entry_contents(ie, self.parent_invs,
664
path, self.work_tree)
665
# describe the nature of the change that has occurred relative to
666
# the basis inventory.
667
if (self.basis_inv.has_id(ie.file_id)):
668
basis_ie = self.basis_inv[ie.file_id]
671
change = ie.describe_change(basis_ie, ie)
672
if change in (InventoryEntry.RENAMED,
673
InventoryEntry.MODIFIED_AND_RENAMED):
674
old_path = self.basis_inv.id2path(ie.file_id)
675
self.reporter.renamed(change, old_path, path)
677
self.reporter.snapshot_change(change, path)
679
if not self.specific_files:
682
# ignore removals that don't match filespec
683
for path, new_ie in self.basis_inv.iter_entries():
684
if new_ie.file_id in self.work_inv:
686
if is_inside_any(self.specific_files, path):
690
self.builder.record_entry_contents(ie, self.parent_invs, path,
693
def _emit_progress_update(self):
694
"""Emit an update to the progress bar."""
695
self.pb.update("Committing", self.pb_count, self.pb_total)
698
def _report_deletes(self):
699
for path, ie in self.basis_inv.iter_entries():
700
if ie.file_id not in self.builder.new_inventory:
699
701
self.reporter.deleted(path)
701
def _populate_from_inventory(self, specific_files):
702
"""Populate the CommitBuilder by walking the working tree inventory."""
704
# raise an exception as soon as we find a single unknown.
705
for unknown in self.work_tree.unknowns():
706
raise StrictCommitFailed()
708
report_changes = self.reporter.is_verbose()
710
# A tree of paths that have been deleted. E.g. if foo/bar has been
711
# deleted, then we have {'foo':{'bar':{}}}
713
# XXX: Note that entries may have the wrong kind because the entry does
714
# not reflect the status on disk.
715
work_inv = self.work_tree.inventory
716
entries = work_inv.iter_entries_by_dir(
717
specific_file_ids=self.specific_file_ids, yield_parents=True)
718
for path, existing_ie in entries:
719
file_id = existing_ie.file_id
720
name = existing_ie.name
721
parent_id = existing_ie.parent_id
722
kind = existing_ie.kind
723
if kind == 'directory':
724
self._next_progress_entry()
725
# Skip files that have been deleted from the working tree.
726
# The deleted path ids are also recorded so they can be explicitly
729
path_segments = splitpath(path)
730
deleted_dict = deleted_paths
731
for segment in path_segments:
732
deleted_dict = deleted_dict.get(segment, None)
734
# We either took a path not present in the dict
735
# (deleted_dict was None), or we've reached an empty
736
# child dir in the dict, so are now a sub-path.
740
if deleted_dict is not None:
741
# the path has a deleted parent, do not add it.
743
content_summary = self.work_tree.path_content_summary(path)
744
# Note that when a filter of specific files is given, we must only
745
# skip/record deleted files matching that filter.
746
if not specific_files or is_inside_any(specific_files, path):
747
if content_summary[0] == 'missing':
748
if not deleted_paths:
749
# path won't have been split yet.
750
path_segments = splitpath(path)
751
deleted_dict = deleted_paths
752
for segment in path_segments:
753
deleted_dict = deleted_dict.setdefault(segment, {})
754
self.reporter.missing(path)
755
deleted_ids.append(file_id)
757
# TODO: have the builder do the nested commit just-in-time IF and
759
if content_summary[0] == 'tree-reference':
760
# enforce repository nested tree policy.
761
if (not self.work_tree.supports_tree_reference() or
762
# repository does not support it either.
763
not self.branch.repository._format.supports_tree_reference):
764
content_summary = ('directory',) + content_summary[1:]
765
kind = content_summary[0]
766
# TODO: specific_files filtering before nested tree processing
767
if kind == 'tree-reference':
768
if self.recursive == 'down':
769
nested_revision_id = self._commit_nested_tree(
771
content_summary = content_summary[:3] + (
774
content_summary = content_summary[:3] + (
775
self.work_tree.get_reference_revision(file_id),)
777
# Record an entry for this item
778
# Note: I don't particularly want to have the existing_ie
779
# parameter but the test suite currently (28-Jun-07) breaks
780
# without it thanks to a unicode normalisation issue. :-(
781
definitely_changed = kind != existing_ie.kind
782
self._record_entry(path, file_id, specific_files, kind, name,
783
parent_id, definitely_changed, existing_ie, report_changes,
786
# Unversion IDs that were found to be deleted
787
self.work_tree.unversion(deleted_ids)
789
def _commit_nested_tree(self, file_id, path):
790
"Commit a nested tree."
791
sub_tree = self.work_tree.get_nested_tree(file_id, path)
792
# FIXME: be more comprehensive here:
793
# this works when both trees are in --trees repository,
794
# but when both are bound to a different repository,
795
# it fails; a better way of approaching this is to
796
# finally implement the explicit-caches approach design
797
# a while back - RBC 20070306.
798
if sub_tree.branch.repository.has_same_location(
799
self.work_tree.branch.repository):
800
sub_tree.branch.repository = \
801
self.work_tree.branch.repository
803
return sub_tree.commit(message=None, revprops=self.revprops,
804
recursive=self.recursive,
805
message_callback=self.message_callback,
806
timestamp=self.timestamp, timezone=self.timezone,
807
committer=self.committer,
808
allow_pointless=self.allow_pointless,
809
strict=self.strict, verbose=self.verbose,
810
local=self.local, reporter=self.reporter)
811
except errors.PointlessCommit:
812
return self.work_tree.get_reference_revision(file_id)
814
def _record_entry(self, path, file_id, specific_files, kind, name,
815
parent_id, definitely_changed, existing_ie, report_changes,
817
"Record the new inventory entry for a path if any."
818
# mutter('check %s {%s}', path, file_id)
819
# mutter('%s selected for commit', path)
820
if definitely_changed or existing_ie is None:
821
ie = make_entry(kind, name, parent_id, file_id)
823
ie = existing_ie.copy()
825
delta, version_recorded = self.builder.record_entry_contents(ie,
826
self.parent_invs, path, self.work_tree, content_summary)
828
self._basis_delta.append(delta)
830
self.any_entries_changed = True
832
self._report_change(ie, path)
835
def _report_change(self, ie, path):
836
"""Report a change to the user.
838
The change that has occurred is described relative to the basis
841
if (self.basis_inv.has_id(ie.file_id)):
842
basis_ie = self.basis_inv[ie.file_id]
845
change = ie.describe_change(basis_ie, ie)
846
if change in (InventoryEntry.RENAMED,
847
InventoryEntry.MODIFIED_AND_RENAMED):
848
old_path = self.basis_inv.id2path(ie.file_id)
849
self.reporter.renamed(change, old_path, path)
851
self.reporter.snapshot_change(change, path)
853
def _set_progress_stage(self, name, entries_title=None):
854
"""Set the progress stage and emit an update to the progress bar."""
855
self.pb_stage_name = name
856
self.pb_stage_count += 1
857
self.pb_entries_title = entries_title
858
if entries_title is not None:
859
self.pb_entries_count = 0
860
self.pb_entries_total = '?'
861
self._emit_progress()
863
def _next_progress_entry(self):
864
"""Emit an update to the progress bar and increment the entry count."""
865
self.pb_entries_count += 1
866
self._emit_progress()
868
def _emit_progress(self):
869
if self.pb_entries_title:
870
if self.pb_entries_total == '?':
871
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
872
self.pb_entries_title, self.pb_entries_count)
874
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
875
self.pb_entries_title, self.pb_entries_count,
876
str(self.pb_entries_total))
878
text = "%s - Stage" % (self.pb_stage_name)
879
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
