279
262
:param exclude: None or a list of relative paths to exclude from the
280
263
commit. Pending changes to excluded files will be ignored by the
282
:param lossy: When committing to a foreign VCS, ignore any
283
data that can not be natively represented.
285
with ExitStack() as stack:
286
self.revprops = revprops or {}
287
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
288
self.config_stack = config or self.config_stack
289
mutter('preparing to commit')
291
if working_tree is None:
292
raise BzrError("working_tree must be passed into commit().")
294
self.work_tree = working_tree
295
self.branch = self.work_tree.branch
296
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
297
if not self.branch.repository.supports_rich_root():
298
raise errors.RootNotRich()
299
if message_callback is None:
300
if message is not None:
301
if isinstance(message, bytes):
302
message = message.decode(get_user_encoding())
304
def message_callback(x):
307
raise BzrError("The message or message_callback keyword"
308
" parameter is required for commit().")
310
self.bound_branch = None
311
self.any_entries_deleted = False
312
if exclude is not None:
313
self.exclude = sorted(
314
minimum_path_selection(exclude))
318
self.master_branch = None
319
self.recursive = recursive
321
# self.specific_files is None to indicate no filter, or any iterable to
322
# indicate a filter - [] means no files at all, as per iter_changes.
323
if specific_files is not None:
324
self.specific_files = sorted(
325
minimum_path_selection(specific_files))
327
self.specific_files = None
329
self.allow_pointless = allow_pointless
330
self.message_callback = message_callback
331
self.timestamp = timestamp
332
self.timezone = timezone
333
self.committer = committer
335
self.verbose = verbose
337
stack.enter_context(self.work_tree.lock_write())
338
self.parents = self.work_tree.get_parent_ids()
339
self.pb = ui.ui_factory.nested_progress_bar()
340
stack.callback(self.pb.finished)
341
self.basis_revid = self.work_tree.last_revision()
342
self.basis_tree = self.work_tree.basis_tree()
343
stack.enter_context(self.basis_tree.lock_read())
344
# Cannot commit with conflicts present.
345
if len(self.work_tree.conflicts()) > 0:
346
raise ConflictsInTree
348
# Setup the bound branch variables as needed.
349
self._check_bound_branch(stack, possible_master_transports)
350
if self.config_stack is None:
351
self.config_stack = self.work_tree.get_config_stack()
353
# Check that the working tree is up to date
354
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
356
# Complete configuration setup
357
if reporter is not None:
358
self.reporter = reporter
359
elif self.reporter is None:
360
self.reporter = self._select_reporter()
362
# Setup the progress bar. As the number of files that need to be
363
# committed in unknown, progress is reported as stages.
364
# We keep track of entries separately though and include that
365
# information in the progress bar during the relevant stages.
366
self.pb_stage_name = ""
367
self.pb_stage_count = 0
368
self.pb_stage_total = 5
369
if self.bound_branch:
370
# 2 extra stages: "Uploading data to master branch" and "Merging
371
# tags to master branch"
372
self.pb_stage_total += 2
373
self.pb.show_pct = False
374
self.pb.show_spinner = False
375
self.pb.show_eta = False
376
self.pb.show_count = True
377
self.pb.show_bar = True
379
# After a merge, a selected file commit is not supported.
380
# See 'bzr help merge' for an explanation as to why.
381
if len(self.parents) > 1 and self.specific_files is not None:
382
raise CannotCommitSelectedFileMerge(self.specific_files)
383
# Excludes are a form of selected file commit.
384
if len(self.parents) > 1 and self.exclude:
385
raise CannotCommitSelectedFileMerge(self.exclude)
387
# Collect the changes
388
self._set_progress_stage("Collecting changes", counter=True)
390
self.builder = self.branch.get_commit_builder(
391
self.parents, self.config_stack, timestamp, timezone, committer,
392
self.revprops, rev_id, lossy=lossy)
394
if self.builder.updates_branch and self.bound_branch:
396
raise AssertionError(
397
"bound branches not supported for commit builders "
398
"that update the branch")
401
# find the location being committed to
402
if self.bound_branch:
403
master_location = self.master_branch.base
405
master_location = self.branch.base
407
# report the start of the commit
408
self.reporter.started(new_revno, self.rev_id, master_location)
410
self._update_builder_with_changes()
411
self._check_pointless()
413
# TODO: Now the new inventory is known, check for conflicts.
414
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
415
# weave lines, because nothing should be recorded until it is known
416
# that commit will succeed.
417
self._set_progress_stage("Saving data locally")
418
self.builder.finish_inventory()
420
# Prompt the user for a commit message if none provided
421
message = message_callback(self)
422
self.message = message
424
# Add revision data to the local branch
425
self.rev_id = self.builder.commit(self.message)
428
mutter("aborting commit write group because of exception:")
429
trace.log_exception_quietly()
433
self._update_branches(old_revno, old_revid, new_revno)
435
# Make the working tree be up to date with the branch. This
436
# includes automatic changes scheduled to be made to the tree, such
437
# as updating its basis and unversioning paths that were missing.
438
self.work_tree.unversion(self.deleted_paths)
439
self._set_progress_stage("Updating the working tree")
440
self.work_tree.update_basis_by_delta(
441
self.rev_id, self.builder.get_basis_delta())
442
self.reporter.completed(new_revno, self.rev_id)
443
self._process_post_hooks(old_revno, new_revno)
446
def _update_branches(self, old_revno, old_revid, new_revno):
447
"""Update the master and local branch to the new revision.
449
This will try to make sure that the master branch is updated
450
before the local branch.
452
:param old_revno: Revision number of master branch before the
454
:param old_revid: Tip of master branch before the commit
455
:param new_revno: Revision number of the new commit
457
if not self.builder.updates_branch:
458
self._process_pre_hooks(old_revno, new_revno)
460
# Upload revision data to the master.
461
# this will propagate merged revisions too if needed.
462
if self.bound_branch:
463
self._set_progress_stage("Uploading data to master branch")
464
# 'commit' to the master first so a timeout here causes the
465
# local branch to be out of date
466
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
467
self.branch, new_revno, self.rev_id, lossy=self._lossy)
469
self.branch.fetch(self.master_branch, self.rev_id)
471
# and now do the commit locally.
472
if new_revno is None:
473
# Keep existing behaviour around ghosts
475
self.branch.set_last_revision_info(new_revno, self.rev_id)
478
self._process_pre_hooks(old_revno, new_revno)
479
except BaseException:
480
# The commit builder will already have updated the branch,
482
self.branch.set_last_revision_info(old_revno, old_revid)
485
# Merge local tags to remote
486
if self.bound_branch:
487
self._set_progress_stage("Merging tags to master branch")
488
tag_updates, tag_conflicts = self.branch.tags.merge_to(
489
self.master_branch.tags)
491
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
492
note(gettext("Conflicting tags in bound branch:\n{0}".format(
493
"\n".join(warning_lines))))
266
operation = OperationWithCleanups(self._commit)
267
self.revprops = revprops or {}
268
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
269
self.config = config or self.config
270
return operation.run(
275
specific_files=specific_files,
277
allow_pointless=allow_pointless,
280
working_tree=working_tree,
283
message_callback=message_callback,
286
possible_master_transports=possible_master_transports)
288
def _commit(self, operation, message, timestamp, timezone, committer,
289
specific_files, rev_id, allow_pointless, strict, verbose,
290
working_tree, local, reporter, message_callback, recursive,
291
exclude, possible_master_transports):
292
mutter('preparing to commit')
294
if working_tree is None:
295
raise BzrError("working_tree must be passed into commit().")
297
self.work_tree = working_tree
298
self.branch = self.work_tree.branch
299
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
300
if not self.branch.repository.supports_rich_root():
301
raise errors.RootNotRich()
302
if message_callback is None:
303
if message is not None:
304
if isinstance(message, str):
305
message = message.decode(get_user_encoding())
306
message_callback = lambda x: message
308
raise BzrError("The message or message_callback keyword"
309
" parameter is required for commit().")
311
self.bound_branch = None
312
self.any_entries_deleted = False
313
if exclude is not None:
314
self.exclude = sorted(
315
minimum_path_selection(exclude))
319
self.master_branch = None
320
self.recursive = recursive
322
# self.specific_files is None to indicate no filter, or any iterable to
323
# indicate a filter - [] means no files at all, as per iter_changes.
324
if specific_files is not None:
325
self.specific_files = sorted(
326
minimum_path_selection(specific_files))
328
self.specific_files = None
330
self.allow_pointless = allow_pointless
331
self.message_callback = message_callback
332
self.timestamp = timestamp
333
self.timezone = timezone
334
self.committer = committer
336
self.verbose = verbose
338
self.work_tree.lock_write()
339
operation.add_cleanup(self.work_tree.unlock)
340
self.parents = self.work_tree.get_parent_ids()
341
# We can use record_iter_changes IFF iter_changes is compatible with
342
# the command line parameters, and the repository has fast delta
343
# generation. See bug 347649.
344
self.use_record_iter_changes = (
346
not self.branch.repository._format.supports_tree_reference and
347
(self.branch.repository._format.fast_deltas or
348
len(self.parents) < 2))
349
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
350
operation.add_cleanup(self.pb.finished)
351
self.basis_revid = self.work_tree.last_revision()
352
self.basis_tree = self.work_tree.basis_tree()
353
self.basis_tree.lock_read()
354
operation.add_cleanup(self.basis_tree.unlock)
355
# Cannot commit with conflicts present.
356
if len(self.work_tree.conflicts()) > 0:
357
raise ConflictsInTree
359
# Setup the bound branch variables as needed.
360
self._check_bound_branch(operation, possible_master_transports)
362
# Check that the working tree is up to date
363
old_revno, new_revno = self._check_out_of_date_tree()
365
# Complete configuration setup
366
if reporter is not None:
367
self.reporter = reporter
368
elif self.reporter is None:
369
self.reporter = self._select_reporter()
370
if self.config is None:
371
self.config = self.branch.get_config()
373
self._set_specific_file_ids()
375
# Setup the progress bar. As the number of files that need to be
376
# committed in unknown, progress is reported as stages.
377
# We keep track of entries separately though and include that
378
# information in the progress bar during the relevant stages.
379
self.pb_stage_name = ""
380
self.pb_stage_count = 0
381
self.pb_stage_total = 5
382
if self.bound_branch:
383
self.pb_stage_total += 1
384
self.pb.show_pct = False
385
self.pb.show_spinner = False
386
self.pb.show_eta = False
387
self.pb.show_count = True
388
self.pb.show_bar = True
390
self._gather_parents()
391
# After a merge, a selected file commit is not supported.
392
# See 'bzr help merge' for an explanation as to why.
393
if len(self.parents) > 1 and self.specific_files is not None:
394
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
395
# Excludes are a form of selected file commit.
396
if len(self.parents) > 1 and self.exclude:
397
raise errors.CannotCommitSelectedFileMerge(self.exclude)
399
# Collect the changes
400
self._set_progress_stage("Collecting changes", counter=True)
401
self.builder = self.branch.get_commit_builder(self.parents,
402
self.config, timestamp, timezone, committer, self.revprops, rev_id)
405
self.builder.will_record_deletes()
406
# find the location being committed to
407
if self.bound_branch:
408
master_location = self.master_branch.base
410
master_location = self.branch.base
412
# report the start of the commit
413
self.reporter.started(new_revno, self.rev_id, master_location)
415
self._update_builder_with_changes()
416
self._check_pointless()
418
# TODO: Now the new inventory is known, check for conflicts.
419
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
420
# weave lines, because nothing should be recorded until it is known
421
# that commit will succeed.
422
self._set_progress_stage("Saving data locally")
423
self.builder.finish_inventory()
425
# Prompt the user for a commit message if none provided
426
message = message_callback(self)
427
self.message = message
429
# Add revision data to the local branch
430
self.rev_id = self.builder.commit(self.message)
433
mutter("aborting commit write group because of exception:")
434
trace.log_exception_quietly()
435
note("aborting commit write group: %r" % (e,))
439
self._process_pre_hooks(old_revno, new_revno)
441
# Upload revision data to the master.
442
# this will propagate merged revisions too if needed.
443
if self.bound_branch:
444
self._set_progress_stage("Uploading data to master branch")
445
# 'commit' to the master first so a timeout here causes the
446
# local branch to be out of date
447
self.master_branch.import_last_revision_info(
448
self.branch.repository, new_revno, self.rev_id)
450
# and now do the commit locally.
451
self.branch.set_last_revision_info(new_revno, self.rev_id)
453
# Make the working tree be up to date with the branch. This
454
# includes automatic changes scheduled to be made to the tree, such
455
# as updating its basis and unversioning paths that were missing.
456
self.work_tree.unversion(self.deleted_ids)
457
self._set_progress_stage("Updating the working tree")
458
self.work_tree.update_basis_by_delta(self.rev_id,
459
self.builder.get_basis_delta())
460
self.reporter.completed(new_revno, self.rev_id)
461
self._process_post_hooks(old_revno, new_revno)
495
464
def _select_reporter(self):
496
465
"""Select the CommitReporter to use."""
680
668
reporter = self.reporter
681
669
report_changes = reporter.is_verbose()
683
671
for change in iter_changes:
684
672
if report_changes:
685
old_path = change.path[0]
686
new_path = change.path[1]
687
versioned = change.versioned[1]
688
kind = change.kind[1]
689
versioned = change.versioned[1]
673
old_path = change[1][0]
674
new_path = change[1][1]
675
versioned = change[3][1]
677
versioned = change[3][1]
690
678
if kind is None and versioned:
692
680
if report_changes:
693
681
reporter.missing(new_path)
694
if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
695
trace.warning('Ignoring "%s" as symlinks are not '
696
'supported on this filesystem.' % (change.path[0],))
698
deleted_paths.append(change.path[1])
682
deleted_ids.append(change[0])
699
683
# Reset the new path (None) and new versioned flag (False)
700
change = change.discard_new()
701
new_path = change.path[1]
684
change = (change[0], (change[1][0], None), change[2],
685
(change[3][0], False)) + change[4:]
703
686
elif kind == 'tree-reference':
704
687
if self.recursive == 'down':
705
self._commit_nested_tree(change.path[1])
706
if change.versioned[0] or change.versioned[1]:
688
self._commit_nested_tree(change[0], change[1][1])
689
if change[3][0] or change[3][1]:
708
691
if report_changes:
709
692
if new_path is None:
710
693
reporter.deleted(old_path)
711
694
elif old_path is None:
712
reporter.snapshot_change(gettext('added'), new_path)
695
reporter.snapshot_change('added', new_path)
713
696
elif old_path != new_path:
714
reporter.renamed(gettext('renamed'),
697
reporter.renamed('renamed', old_path, new_path)
718
or self.work_tree.branch.repository._format.rich_root_data):
700
self.work_tree.branch.repository._format.rich_root_data):
719
701
# Don't report on changes to '' in non rich root
721
reporter.snapshot_change(
722
gettext('modified'), new_path)
703
reporter.snapshot_change('modified', new_path)
723
704
self._next_progress_entry()
724
# Unversion files that were found to be deleted
725
self.deleted_paths = deleted_paths
705
# Unversion IDs that were found to be deleted
706
self.deleted_ids = deleted_ids
708
def _record_unselected(self):
709
# If specific files are selected, then all un-selected files must be
710
# recorded in their previous state. For more details, see
711
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
712
if self.specific_files or self.exclude:
713
specific_files = self.specific_files or []
714
for path, old_ie in self.basis_inv.iter_entries():
715
if old_ie.file_id in self.builder.new_inventory:
716
# already added - skip.
718
if (is_inside_any(specific_files, path)
719
and not is_inside_any(self.exclude, path)):
720
# was inside the selected path, and not excluded - if not
721
# present it has been deleted so skip.
723
# From here down it was either not selected, or was excluded:
724
# We preserve the entry unaltered.
726
# Note: specific file commits after a merge are currently
727
# prohibited. This test is for sanity/safety in case it's
728
# required after that changes.
729
if len(self.parents) > 1:
731
self.builder.record_entry_contents(ie, self.parent_invs, path,
732
self.basis_tree, None)
734
def _report_and_accumulate_deletes(self):
735
if (isinstance(self.basis_inv, Inventory)
736
and isinstance(self.builder.new_inventory, Inventory)):
737
# the older Inventory classes provide a _byid dict, and building a
738
# set from the keys of this dict is substantially faster than even
739
# getting a set of ids from the inventory
741
# <lifeless> set(dict) is roughly the same speed as
742
# set(iter(dict)) and both are significantly slower than
744
deleted_ids = set(self.basis_inv._byid.keys()) - \
745
set(self.builder.new_inventory._byid.keys())
747
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
749
self.any_entries_deleted = True
750
deleted = [(self.basis_tree.id2path(file_id), file_id)
751
for file_id in deleted_ids]
753
# XXX: this is not quite directory-order sorting
754
for path, file_id in deleted:
755
self.builder.record_delete(path, file_id)
756
self.reporter.deleted(path)
727
758
def _check_strict(self):
728
759
# XXX: when we use iter_changes this would likely be faster if
733
764
for unknown in self.work_tree.unknowns():
734
765
raise StrictCommitFailed()
736
def _commit_nested_tree(self, path):
767
def _populate_from_inventory(self):
768
"""Populate the CommitBuilder by walking the working tree inventory."""
769
# Build the revision inventory.
771
# This starts by creating a new empty inventory. Depending on
772
# which files are selected for commit, and what is present in the
773
# current tree, the new inventory is populated. inventory entries
774
# which are candidates for modification have their revision set to
775
# None; inventory entries that are carried over untouched have their
776
# revision set to their prior value.
778
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
779
# results to create a new inventory at the same time, which results
780
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
783
specific_files = self.specific_files
784
exclude = self.exclude
785
report_changes = self.reporter.is_verbose()
787
# A tree of paths that have been deleted. E.g. if foo/bar has been
788
# deleted, then we have {'foo':{'bar':{}}}
790
# XXX: Note that entries may have the wrong kind because the entry does
791
# not reflect the status on disk.
792
work_inv = self.work_tree.inventory
793
# NB: entries will include entries within the excluded ids/paths
794
# because iter_entries_by_dir has no 'exclude' facility today.
795
entries = work_inv.iter_entries_by_dir(
796
specific_file_ids=self.specific_file_ids, yield_parents=True)
797
for path, existing_ie in entries:
798
file_id = existing_ie.file_id
799
name = existing_ie.name
800
parent_id = existing_ie.parent_id
801
kind = existing_ie.kind
802
# Skip files that have been deleted from the working tree.
803
# The deleted path ids are also recorded so they can be explicitly
806
path_segments = splitpath(path)
807
deleted_dict = deleted_paths
808
for segment in path_segments:
809
deleted_dict = deleted_dict.get(segment, None)
811
# We either took a path not present in the dict
812
# (deleted_dict was None), or we've reached an empty
813
# child dir in the dict, so are now a sub-path.
817
if deleted_dict is not None:
818
# the path has a deleted parent, do not add it.
820
if exclude and is_inside_any(exclude, path):
821
# Skip excluded paths. Excluded paths are processed by
822
# _update_builder_with_changes.
824
content_summary = self.work_tree.path_content_summary(path)
825
kind = content_summary[0]
826
# Note that when a filter of specific files is given, we must only
827
# skip/record deleted files matching that filter.
828
if not specific_files or is_inside_any(specific_files, path):
829
if kind == 'missing':
830
if not deleted_paths:
831
# path won't have been split yet.
832
path_segments = splitpath(path)
833
deleted_dict = deleted_paths
834
for segment in path_segments:
835
deleted_dict = deleted_dict.setdefault(segment, {})
836
self.reporter.missing(path)
837
self._next_progress_entry()
838
deleted_ids.append(file_id)
840
# TODO: have the builder do the nested commit just-in-time IF and
842
if kind == 'tree-reference':
843
# enforce repository nested tree policy.
844
if (not self.work_tree.supports_tree_reference() or
845
# repository does not support it either.
846
not self.branch.repository._format.supports_tree_reference):
848
content_summary = (kind, None, None, None)
849
elif self.recursive == 'down':
850
nested_revision_id = self._commit_nested_tree(
852
content_summary = (kind, None, None, nested_revision_id)
854
nested_revision_id = self.work_tree.get_reference_revision(file_id)
855
content_summary = (kind, None, None, nested_revision_id)
857
# Record an entry for this item
858
# Note: I don't particularly want to have the existing_ie
859
# parameter but the test suite currently (28-Jun-07) breaks
860
# without it thanks to a unicode normalisation issue. :-(
861
definitely_changed = kind != existing_ie.kind
862
self._record_entry(path, file_id, specific_files, kind, name,
863
parent_id, definitely_changed, existing_ie, report_changes,
866
# Unversion IDs that were found to be deleted
867
self.deleted_ids = deleted_ids
869
def _commit_nested_tree(self, file_id, path):
737
870
"Commit a nested tree."
738
sub_tree = self.work_tree.get_nested_tree(path)
871
sub_tree = self.work_tree.get_nested_tree(file_id, path)
739
872
# FIXME: be more comprehensive here:
740
873
# this works when both trees are in --trees repository,
741
874
# but when both are bound to a different repository,
743
876
# finally implement the explicit-caches approach design
744
877
# a while back - RBC 20070306.
745
878
if sub_tree.branch.repository.has_same_location(
746
self.work_tree.branch.repository):
879
self.work_tree.branch.repository):
747
880
sub_tree.branch.repository = \
748
881
self.work_tree.branch.repository
750
883
return sub_tree.commit(message=None, revprops=self.revprops,
751
recursive=self.recursive,
752
message_callback=self.message_callback,
753
timestamp=self.timestamp,
754
timezone=self.timezone,
755
committer=self.committer,
756
allow_pointless=self.allow_pointless,
757
strict=self.strict, verbose=self.verbose,
758
local=self.local, reporter=self.reporter)
759
except PointlessCommit:
760
return self.work_tree.get_reference_revision(path)
884
recursive=self.recursive,
885
message_callback=self.message_callback,
886
timestamp=self.timestamp, timezone=self.timezone,
887
committer=self.committer,
888
allow_pointless=self.allow_pointless,
889
strict=self.strict, verbose=self.verbose,
890
local=self.local, reporter=self.reporter)
891
except errors.PointlessCommit:
892
return self.work_tree.get_reference_revision(file_id)
894
def _record_entry(self, path, file_id, specific_files, kind, name,
895
parent_id, definitely_changed, existing_ie, report_changes,
897
"Record the new inventory entry for a path if any."
898
# mutter('check %s {%s}', path, file_id)
899
# mutter('%s selected for commit', path)
900
if definitely_changed or existing_ie is None:
901
ie = make_entry(kind, name, parent_id, file_id)
903
ie = existing_ie.copy()
905
# For carried over entries we don't care about the fs hash - the repo
906
# isn't generating a sha, so we're not saving computation time.
907
_, _, fs_hash = self.builder.record_entry_contents(
908
ie, self.parent_invs, path, self.work_tree, content_summary)
910
self._report_change(ie, path)
912
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
915
def _report_change(self, ie, path):
916
"""Report a change to the user.
918
The change that has occurred is described relative to the basis
921
if (self.basis_inv.has_id(ie.file_id)):
922
basis_ie = self.basis_inv[ie.file_id]
925
change = ie.describe_change(basis_ie, ie)
926
if change in (InventoryEntry.RENAMED,
927
InventoryEntry.MODIFIED_AND_RENAMED):
928
old_path = self.basis_inv.id2path(ie.file_id)
929
self.reporter.renamed(change, old_path, path)
930
self._next_progress_entry()
932
if change == 'unchanged':
934
self.reporter.snapshot_change(change, path)
935
self._next_progress_entry()
762
937
def _set_progress_stage(self, name, counter=False):
763
938
"""Set the progress stage and emit an update to the progress bar."""