49
50
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
51
# the rest of the code; add a deprecation of the old name.
59
from bzrlib.branch import Branch
60
from bzrlib.cleanup import OperationWithCleanups
62
from bzrlib.errors import (BzrError, PointlessCommit,
66
from bzrlib.osutils import (get_user_encoding,
68
minimum_path_selection,
71
from bzrlib.trace import mutter, note, is_quiet
72
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
73
from bzrlib import symbol_versioning
74
from bzrlib.urlutils import unescape_for_display
60
from .branch import Branch
61
from .cleanup import OperationWithCleanups
63
from .errors import (BzrError,
67
from .osutils import (get_user_encoding,
69
minimum_path_selection,
72
from .trace import mutter, note, is_quiet
73
from .bzr.inventory import Inventory, InventoryEntry, make_entry
74
from .urlutils import unescape_for_display
75
from .i18n import gettext
78
class PointlessCommit(BzrError):
80
_fmt = "No changes to commit"
83
class CannotCommitSelectedFileMerge(BzrError):
85
_fmt = 'Selected-file commit of merges is not supported yet:'\
86
' files %(files_str)s'
88
def __init__(self, files):
89
files_str = ', '.join(files)
90
BzrError.__init__(self, files=files, files_str=files_str)
93
def filter_excluded(iter_changes, exclude):
94
"""Filter exclude filenames.
96
:param iter_changes: iter_changes function
97
:param exclude: List of paths to exclude
98
:return: iter_changes function
100
for change in iter_changes:
101
old_path = change[1][0]
102
new_path = change[1][1]
104
new_excluded = (new_path is not None and
105
is_inside_any(exclude, new_path))
107
old_excluded = (old_path is not None and
108
is_inside_any(exclude, old_path))
110
if old_excluded and new_excluded:
113
if old_excluded or new_excluded:
114
# TODO(jelmer): Perhaps raise an error here instead?
78
120
class NullCommitReporter(object):
79
121
"""I report on progress of a commit."""
81
def started(self, revno, revid, location=None):
83
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
84
"to started.", DeprecationWarning,
123
def started(self, revno, revid, location):
88
126
def snapshot_change(self, change, path):
114
152
note(format, *args)
116
154
def snapshot_change(self, change, path):
117
if path == '' and change in ('added', 'modified'):
155
if path == '' and change in (gettext('added'), gettext('modified')):
119
157
self._note("%s %s", change, path)
121
def started(self, revno, rev_id, location=None):
122
if location is not None:
123
location = ' to: ' + unescape_for_display(location, 'utf-8')
125
# When started was added, location was only made optional by
126
# accident. Matt Nordhoff 20071129
127
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
128
"to started.", DeprecationWarning,
131
self._note('Committing%s', location)
159
def started(self, revno, rev_id, location):
161
gettext('Committing to: %s'),
162
unescape_for_display(location, 'utf-8'))
133
164
def completed(self, revno, rev_id):
134
self._note('Committed revision %d.', revno)
165
self._note(gettext('Committed revision %d.'), revno)
135
166
# self._note goes to the console too; so while we want to log the
136
167
# rev_id, we can't trivially only log it. (See bug 526425). Long
137
168
# term we should rearrange the reporting structure, but for now
167
198
def __init__(self,
170
201
"""Create a Commit object.
172
203
:param reporter: the default reporter to use or None to decide later
174
205
self.reporter = reporter
206
self.config_stack = config_stack
178
def update_revprops(revprops, branch, authors=None, author=None,
209
def update_revprops(revprops, branch, authors=None,
179
210
local=False, possible_master_transports=None):
180
211
if revprops is None:
182
213
if possible_master_transports is None:
183
214
possible_master_transports = []
184
if not 'branch-nick' in revprops:
215
if (not 'branch-nick' in revprops and
216
branch.repository._format.supports_storing_branch_nick):
185
217
revprops['branch-nick'] = branch._get_nick(
187
219
possible_master_transports)
188
220
if authors is not None:
189
if author is not None:
190
raise AssertionError('Specifying both author and authors '
191
'is not allowed. Specify just authors instead')
192
221
if 'author' in revprops or 'authors' in revprops:
193
222
# XXX: maybe we should just accept one of them?
194
223
raise AssertionError('author property given twice')
283
304
message_callback=message_callback,
284
305
recursive=recursive,
286
possible_master_transports=possible_master_transports)
307
possible_master_transports=possible_master_transports,
288
310
def _commit(self, operation, message, timestamp, timezone, committer,
289
311
specific_files, rev_id, allow_pointless, strict, verbose,
290
312
working_tree, local, reporter, message_callback, recursive,
291
exclude, possible_master_transports):
313
exclude, possible_master_transports, lossy):
292
314
mutter('preparing to commit')
294
316
if working_tree is None:
380
392
self.pb_stage_count = 0
381
393
self.pb_stage_total = 5
382
394
if self.bound_branch:
383
self.pb_stage_total += 1
395
# 2 extra stages: "Uploading data to master branch" and "Merging
396
# tags to master branch"
397
self.pb_stage_total += 2
384
398
self.pb.show_pct = False
385
399
self.pb.show_spinner = False
386
400
self.pb.show_eta = False
387
401
self.pb.show_count = True
388
402
self.pb.show_bar = True
390
self._gather_parents()
391
404
# After a merge, a selected file commit is not supported.
392
405
# See 'bzr help merge' for an explanation as to why.
393
406
if len(self.parents) > 1 and self.specific_files is not None:
394
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
407
raise CannotCommitSelectedFileMerge(self.specific_files)
395
408
# Excludes are a form of selected file commit.
396
409
if len(self.parents) > 1 and self.exclude:
397
raise errors.CannotCommitSelectedFileMerge(self.exclude)
410
raise CannotCommitSelectedFileMerge(self.exclude)
399
412
# Collect the changes
400
413
self._set_progress_stage("Collecting changes", counter=True)
401
415
self.builder = self.branch.get_commit_builder(self.parents,
402
self.config, timestamp, timezone, committer, self.revprops, rev_id)
416
self.config_stack, timestamp, timezone, committer, self.revprops,
419
if self.builder.updates_branch and self.bound_branch:
421
raise AssertionError(
422
"bound branches not supported for commit builders "
423
"that update the branch")
405
self.builder.will_record_deletes()
406
426
# find the location being committed to
407
427
if self.bound_branch:
408
428
master_location = self.master_branch.base
429
449
# Add revision data to the local branch
430
450
self.rev_id = self.builder.commit(self.message)
452
except Exception as e:
433
453
mutter("aborting commit write group because of exception:")
434
454
trace.log_exception_quietly()
435
note("aborting commit write group: %r" % (e,))
436
455
self.builder.abort()
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)
458
self._update_branches(old_revno, old_revid, new_revno)
453
460
# Make the working tree be up to date with the branch. This
454
461
# includes automatic changes scheduled to be made to the tree, such
455
462
# as updating its basis and unversioning paths that were missing.
456
self.work_tree.unversion(self.deleted_ids)
463
self.work_tree.unversion(
464
{self.work_tree.id2path(file_id) for file_id in self.deleted_ids},
457
466
self._set_progress_stage("Updating the working tree")
458
467
self.work_tree.update_basis_by_delta(self.rev_id,
459
468
self.builder.get_basis_delta())
461
470
self._process_post_hooks(old_revno, new_revno)
462
471
return self.rev_id
473
def _update_branches(self, old_revno, old_revid, new_revno):
474
"""Update the master and local branch to the new revision.
476
This will try to make sure that the master branch is updated
477
before the local branch.
479
:param old_revno: Revision number of master branch before the
481
:param old_revid: Tip of master branch before the commit
482
:param new_revno: Revision number of the new commit
484
if not self.builder.updates_branch:
485
self._process_pre_hooks(old_revno, new_revno)
487
# Upload revision data to the master.
488
# this will propagate merged revisions too if needed.
489
if self.bound_branch:
490
self._set_progress_stage("Uploading data to master branch")
491
# 'commit' to the master first so a timeout here causes the
492
# local branch to be out of date
493
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
494
self.branch, new_revno, self.rev_id, lossy=self._lossy)
496
self.branch.fetch(self.master_branch, self.rev_id)
498
# and now do the commit locally.
499
self.branch.set_last_revision_info(new_revno, self.rev_id)
502
self._process_pre_hooks(old_revno, new_revno)
504
# The commit builder will already have updated the branch,
506
self.branch.set_last_revision_info(old_revno, old_revid)
509
# Merge local tags to remote
510
if self.bound_branch:
511
self._set_progress_stage("Merging tags to master branch")
512
tag_updates, tag_conflicts = self.branch.tags.merge_to(
513
self.master_branch.tags)
515
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
516
note( gettext("Conflicting tags in bound branch:\n{0}".format(
517
"\n".join(warning_lines))) )
464
519
def _select_reporter(self):
465
520
"""Select the CommitReporter to use."""
541
588
# this is so that we still consider the master branch
542
589
# - in a checkout scenario the tree may have no
543
590
# parents but the branch may do.
544
first_tree_parent = bzrlib.revision.NULL_REVISION
591
first_tree_parent = breezy.revision.NULL_REVISION
545
592
old_revno, master_last = self.master_branch.last_revision_info()
546
593
if master_last != first_tree_parent:
547
if master_last != bzrlib.revision.NULL_REVISION:
594
if master_last != breezy.revision.NULL_REVISION:
548
595
raise errors.OutOfDateTree(self.work_tree)
549
596
if self.branch.repository.has_revision(first_tree_parent):
550
597
new_revno = old_revno + 1
552
599
# ghost parents never appear in revision history.
554
return old_revno,new_revno
601
return old_revno, master_last, new_revno
556
603
def _process_pre_hooks(self, old_revno, new_revno):
557
604
"""Process any registered pre commit hooks."""
618
666
old_revno, old_revid, new_revno, self.rev_id,
619
667
tree_delta, future_tree)
621
def _gather_parents(self):
622
"""Record the parents of a merge for merge detection."""
623
# TODO: Make sure that this list doesn't contain duplicate
624
# entries and the order is preserved when doing this.
625
if self.use_record_iter_changes:
627
self.basis_inv = self.basis_tree.inventory
628
self.parent_invs = [self.basis_inv]
629
for revision in self.parents[1:]:
630
if self.branch.repository.has_revision(revision):
631
mutter('commit parent revision {%s}', revision)
632
inventory = self.branch.repository.get_inventory(revision)
633
self.parent_invs.append(inventory)
635
mutter('commit parent ghost revision {%s}', revision)
637
669
def _update_builder_with_changes(self):
638
670
"""Update the commit builder with the data about what has changed.
640
exclude = self.exclude
641
672
specific_files = self.specific_files
642
mutter("Selecting files for commit with filter %s", specific_files)
673
mutter("Selecting files for commit with filter %r", specific_files)
644
675
self._check_strict()
645
if self.use_record_iter_changes:
646
iter_changes = self.work_tree.iter_changes(self.basis_tree,
647
specific_files=specific_files)
648
iter_changes = self._filter_iter_changes(iter_changes)
649
for file_id, path, fs_hash in self.builder.record_iter_changes(
650
self.work_tree, self.basis_revid, iter_changes):
651
self.work_tree._observed_sha1(file_id, path, fs_hash)
653
# Build the new inventory
654
self._populate_from_inventory()
655
self._record_unselected()
656
self._report_and_accumulate_deletes()
676
iter_changes = self.work_tree.iter_changes(self.basis_tree,
677
specific_files=specific_files)
679
iter_changes = filter_excluded(iter_changes, self.exclude)
680
iter_changes = self._filter_iter_changes(iter_changes)
681
for file_id, path, fs_hash in self.builder.record_iter_changes(
682
self.work_tree, self.basis_revid, iter_changes):
683
self.work_tree._observed_sha1(file_id, path, fs_hash)
658
685
def _filter_iter_changes(self, iter_changes):
659
686
"""Process iter_changes.
692
721
if new_path is None:
693
722
reporter.deleted(old_path)
694
723
elif old_path is None:
695
reporter.snapshot_change('added', new_path)
724
reporter.snapshot_change(gettext('added'), new_path)
696
725
elif old_path != new_path:
697
reporter.renamed('renamed', old_path, new_path)
726
reporter.renamed(gettext('renamed'), old_path, new_path)
700
729
self.work_tree.branch.repository._format.rich_root_data):
701
730
# Don't report on changes to '' in non rich root
703
reporter.snapshot_change('modified', new_path)
732
reporter.snapshot_change(gettext('modified'), new_path)
704
733
self._next_progress_entry()
705
734
# Unversion IDs that were found to be deleted
706
735
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)
758
737
def _check_strict(self):
759
738
# XXX: when we use iter_changes this would likely be faster if
760
739
# iter_changes would check for us (even in the presence of
764
743
for unknown in self.work_tree.unknowns():
765
744
raise StrictCommitFailed()
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
746
def _commit_nested_tree(self, file_id, path):
870
747
"Commit a nested tree."
871
sub_tree = self.work_tree.get_nested_tree(file_id, path)
748
sub_tree = self.work_tree.get_nested_tree(path, file_id)
872
749
# FIXME: be more comprehensive here:
873
750
# this works when both trees are in --trees repository,
874
751
# but when both are bound to a different repository,
888
765
allow_pointless=self.allow_pointless,
889
766
strict=self.strict, verbose=self.verbose,
890
767
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()
768
except PointlessCommit:
769
return self.work_tree.get_reference_revision(path, file_id)
937
771
def _set_progress_stage(self, name, counter=False):
938
772
"""Set the progress stage and emit an update to the progress bar."""
952
786
def _emit_progress(self):
953
787
if self.pb_entries_count is not None:
954
text = "%s [%d] - Stage" % (self.pb_stage_name,
788
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
955
789
self.pb_entries_count)
957
text = "%s - Stage" % (self.pb_stage_name, )
791
text = gettext("%s - Stage") % (self.pb_stage_name, )
958
792
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
960
def _set_specific_file_ids(self):
961
"""populate self.specific_file_ids if we will use it."""
962
if not self.use_record_iter_changes:
963
# If provided, ensure the specified files are versioned
964
if self.specific_files is not None:
965
# Note: This routine is being called because it raises
966
# PathNotVersionedError as a side effect of finding the IDs. We
967
# later use the ids we found as input to the working tree
968
# inventory iterator, so we only consider those ids rather than
969
# examining the whole tree again.
970
# XXX: Dont we have filter_unversioned to do this more
972
self.specific_file_ids = tree.find_ids_across_trees(
973
self.specific_files, [self.basis_tree, self.work_tree])
975
self.specific_file_ids = None
added
removed
breezy/commit.py
