50
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
50
# the rest of the code; add a deprecation of the old name.
59
from .branch import Branch
60
from .cleanup import OperationWithCleanups
62
from .errors import (BzrError,
66
from .osutils import (get_user_encoding,
68
minimum_path_selection,
70
from .trace import mutter, note, is_quiet
71
from .urlutils import unescape_for_display
72
from .i18n import gettext
75
class PointlessCommit(BzrError):
77
_fmt = "No changes to commit"
80
class CannotCommitSelectedFileMerge(BzrError):
82
_fmt = 'Selected-file commit of merges is not supported yet:'\
83
' files %(files_str)s'
85
def __init__(self, files):
86
files_str = ', '.join(files)
87
BzrError.__init__(self, files=files, files_str=files_str)
90
def filter_excluded(iter_changes, exclude):
91
"""Filter exclude filenames.
93
:param iter_changes: iter_changes function
94
:param exclude: List of paths to exclude
95
:return: iter_changes function
97
for change in iter_changes:
98
old_path = change[1][0]
99
new_path = change[1][1]
101
new_excluded = (new_path is not None and
102
is_inside_any(exclude, new_path))
104
old_excluded = (old_path is not None and
105
is_inside_any(exclude, old_path))
107
if old_excluded and new_excluded:
110
if old_excluded or new_excluded:
111
# TODO(jelmer): Perhaps raise an error here instead?
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
117
78
class NullCommitReporter(object):
118
79
"""I report on progress of a commit."""
120
def started(self, revno, revid, location):
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
88
def snapshot_change(self, change, path):
149
114
note(format, *args)
151
116
def snapshot_change(self, change, path):
152
if path == '' and change in (gettext('added'), gettext('modified')):
117
if path == '' and change in ('added', 'modified'):
154
119
self._note("%s %s", change, path)
156
def started(self, revno, rev_id, location):
158
gettext('Committing to: %s'),
159
unescape_for_display(location, 'utf-8'))
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)
161
133
def completed(self, revno, rev_id):
162
self._note(gettext('Committed revision %d.'), revno)
134
self._note('Committed revision %d.', revno)
163
135
# self._note goes to the console too; so while we want to log the
164
136
# rev_id, we can't trivially only log it. (See bug 526425). Long
165
137
# term we should rearrange the reporting structure, but for now
195
167
def __init__(self,
198
170
"""Create a Commit object.
200
172
:param reporter: the default reporter to use or None to decide later
202
174
self.reporter = reporter
203
self.config_stack = config_stack
206
def update_revprops(revprops, branch, authors=None,
207
local=False, possible_master_transports=None):
210
if possible_master_transports is None:
211
possible_master_transports = []
212
if (not u'branch-nick' in revprops and
213
branch.repository._format.supports_storing_branch_nick):
214
revprops[u'branch-nick'] = branch._get_nick(
216
possible_master_transports)
217
if authors is not None:
218
if u'author' in revprops or u'authors' in revprops:
219
# XXX: maybe we should just accept one of them?
220
raise AssertionError('author property given twice')
222
for individual in authors:
223
if '\n' in individual:
224
raise AssertionError('\\n is not a valid character '
225
'in an author identity')
226
revprops[u'authors'] = '\n'.join(authors)
301
246
message_callback=message_callback,
302
247
recursive=recursive,
304
possible_master_transports=possible_master_transports,
249
possible_master_transports=possible_master_transports)
307
251
def _commit(self, operation, message, timestamp, timezone, committer,
308
252
specific_files, rev_id, allow_pointless, strict, verbose,
309
253
working_tree, local, reporter, message_callback, recursive,
310
exclude, possible_master_transports, lossy):
254
exclude, possible_master_transports):
311
255
mutter('preparing to commit')
313
257
if working_tree is None:
389
343
self.pb_stage_count = 0
390
344
self.pb_stage_total = 5
391
345
if self.bound_branch:
392
# 2 extra stages: "Uploading data to master branch" and "Merging
393
# tags to master branch"
394
self.pb_stage_total += 2
346
self.pb_stage_total += 1
395
347
self.pb.show_pct = False
396
348
self.pb.show_spinner = False
397
349
self.pb.show_eta = False
398
350
self.pb.show_count = True
399
351
self.pb.show_bar = True
353
self._gather_parents()
401
354
# After a merge, a selected file commit is not supported.
402
355
# See 'bzr help merge' for an explanation as to why.
403
356
if len(self.parents) > 1 and self.specific_files is not None:
404
raise CannotCommitSelectedFileMerge(self.specific_files)
357
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
405
358
# Excludes are a form of selected file commit.
406
359
if len(self.parents) > 1 and self.exclude:
407
raise CannotCommitSelectedFileMerge(self.exclude)
360
raise errors.CannotCommitSelectedFileMerge(self.exclude)
409
362
# Collect the changes
410
363
self._set_progress_stage("Collecting changes", counter=True)
412
364
self.builder = self.branch.get_commit_builder(self.parents,
413
self.config_stack, timestamp, timezone, committer, self.revprops,
416
if self.builder.updates_branch and self.bound_branch:
418
raise AssertionError(
419
"bound branches not supported for commit builders "
420
"that update the branch")
365
self.config, timestamp, timezone, committer, self.revprops, rev_id)
368
self.builder.will_record_deletes()
423
369
# find the location being committed to
424
370
if self.bound_branch:
425
371
master_location = self.master_branch.base
446
392
# Add revision data to the local branch
447
393
self.rev_id = self.builder.commit(self.message)
449
except Exception as e:
450
396
mutter("aborting commit write group because of exception:")
451
397
trace.log_exception_quietly()
398
note("aborting commit write group: %r" % (e,))
452
399
self.builder.abort()
455
self._update_branches(old_revno, old_revid, new_revno)
402
self._process_pre_hooks(old_revno, new_revno)
404
# Upload revision data to the master.
405
# this will propagate merged revisions too if needed.
406
if self.bound_branch:
407
self._set_progress_stage("Uploading data to master branch")
408
# 'commit' to the master first so a timeout here causes the
409
# local branch to be out of date
410
self.master_branch.import_last_revision_info(
411
self.branch.repository, new_revno, self.rev_id)
413
# and now do the commit locally.
414
self.branch.set_last_revision_info(new_revno, self.rev_id)
457
416
# Make the working tree be up to date with the branch. This
458
417
# includes automatic changes scheduled to be made to the tree, such
459
418
# as updating its basis and unversioning paths that were missing.
460
self.work_tree.unversion(self.deleted_paths)
419
self.work_tree.unversion(self.deleted_ids)
461
420
self._set_progress_stage("Updating the working tree")
462
421
self.work_tree.update_basis_by_delta(self.rev_id,
463
422
self.builder.get_basis_delta())
465
424
self._process_post_hooks(old_revno, new_revno)
466
425
return self.rev_id
468
def _update_branches(self, old_revno, old_revid, new_revno):
469
"""Update the master and local branch to the new revision.
471
This will try to make sure that the master branch is updated
472
before the local branch.
474
:param old_revno: Revision number of master branch before the
476
:param old_revid: Tip of master branch before the commit
477
:param new_revno: Revision number of the new commit
479
if not self.builder.updates_branch:
480
self._process_pre_hooks(old_revno, new_revno)
482
# Upload revision data to the master.
483
# this will propagate merged revisions too if needed.
484
if self.bound_branch:
485
self._set_progress_stage("Uploading data to master branch")
486
# 'commit' to the master first so a timeout here causes the
487
# local branch to be out of date
488
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
489
self.branch, new_revno, self.rev_id, lossy=self._lossy)
491
self.branch.fetch(self.master_branch, self.rev_id)
493
# and now do the commit locally.
494
self.branch.set_last_revision_info(new_revno, self.rev_id)
497
self._process_pre_hooks(old_revno, new_revno)
499
# The commit builder will already have updated the branch,
501
self.branch.set_last_revision_info(old_revno, old_revid)
504
# Merge local tags to remote
505
if self.bound_branch:
506
self._set_progress_stage("Merging tags to master branch")
507
tag_updates, tag_conflicts = self.branch.tags.merge_to(
508
self.master_branch.tags)
510
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
511
note( gettext("Conflicting tags in bound branch:\n{0}".format(
512
"\n".join(warning_lines))) )
514
427
def _select_reporter(self):
515
428
"""Select the CommitReporter to use."""
583
504
# this is so that we still consider the master branch
584
505
# - in a checkout scenario the tree may have no
585
506
# parents but the branch may do.
586
first_tree_parent = breezy.revision.NULL_REVISION
507
first_tree_parent = bzrlib.revision.NULL_REVISION
587
508
old_revno, master_last = self.master_branch.last_revision_info()
588
509
if master_last != first_tree_parent:
589
if master_last != breezy.revision.NULL_REVISION:
510
if master_last != bzrlib.revision.NULL_REVISION:
590
511
raise errors.OutOfDateTree(self.work_tree)
591
512
if self.branch.repository.has_revision(first_tree_parent):
592
513
new_revno = old_revno + 1
594
515
# ghost parents never appear in revision history.
596
return old_revno, master_last, new_revno
517
return old_revno,new_revno
598
519
def _process_pre_hooks(self, old_revno, new_revno):
599
520
"""Process any registered pre commit hooks."""
661
581
old_revno, old_revid, new_revno, self.rev_id,
662
582
tree_delta, future_tree)
584
def _gather_parents(self):
585
"""Record the parents of a merge for merge detection."""
586
# TODO: Make sure that this list doesn't contain duplicate
587
# entries and the order is preserved when doing this.
588
if self.use_record_iter_changes:
590
self.basis_inv = self.basis_tree.inventory
591
self.parent_invs = [self.basis_inv]
592
for revision in self.parents[1:]:
593
if self.branch.repository.has_revision(revision):
594
mutter('commit parent revision {%s}', revision)
595
inventory = self.branch.repository.get_inventory(revision)
596
self.parent_invs.append(inventory)
598
mutter('commit parent ghost revision {%s}', revision)
664
600
def _update_builder_with_changes(self):
665
601
"""Update the commit builder with the data about what has changed.
603
exclude = self.exclude
667
604
specific_files = self.specific_files
668
mutter("Selecting files for commit with filter %r", specific_files)
605
mutter("Selecting files for commit with filter %s", specific_files)
670
607
self._check_strict()
671
iter_changes = self.work_tree.iter_changes(self.basis_tree,
672
specific_files=specific_files)
674
iter_changes = filter_excluded(iter_changes, self.exclude)
675
iter_changes = self._filter_iter_changes(iter_changes)
676
for file_id, path, fs_hash in self.builder.record_iter_changes(
677
self.work_tree, self.basis_revid, iter_changes):
678
self.work_tree._observed_sha1(file_id, path, fs_hash)
608
if self.use_record_iter_changes:
609
iter_changes = self.work_tree.iter_changes(self.basis_tree,
610
specific_files=specific_files)
611
iter_changes = self._filter_iter_changes(iter_changes)
612
for file_id, path, fs_hash in self.builder.record_iter_changes(
613
self.work_tree, self.basis_revid, iter_changes):
614
self.work_tree._observed_sha1(file_id, path, fs_hash)
616
# Build the new inventory
617
self._populate_from_inventory()
618
self._record_unselected()
619
self._report_and_accumulate_deletes()
680
621
def _filter_iter_changes(self, iter_changes):
681
622
"""Process iter_changes.
716
655
if new_path is None:
717
656
reporter.deleted(old_path)
718
657
elif old_path is None:
719
reporter.snapshot_change(gettext('added'), new_path)
658
reporter.snapshot_change('added', new_path)
720
659
elif old_path != new_path:
721
reporter.renamed(gettext('renamed'), old_path, new_path)
660
reporter.renamed('renamed', old_path, new_path)
724
663
self.work_tree.branch.repository._format.rich_root_data):
725
664
# Don't report on changes to '' in non rich root
727
reporter.snapshot_change(gettext('modified'), new_path)
666
reporter.snapshot_change('modified', new_path)
728
667
self._next_progress_entry()
729
# Unversion files that were found to be deleted
730
self.deleted_paths = deleted_paths
668
# Unversion IDs that were found to be deleted
669
self.deleted_ids = deleted_ids
671
def _record_unselected(self):
672
# If specific files are selected, then all un-selected files must be
673
# recorded in their previous state. For more details, see
674
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
675
if self.specific_files or self.exclude:
676
specific_files = self.specific_files or []
677
for path, old_ie in self.basis_inv.iter_entries():
678
if old_ie.file_id in self.builder.new_inventory:
679
# already added - skip.
681
if (is_inside_any(specific_files, path)
682
and not is_inside_any(self.exclude, path)):
683
# was inside the selected path, and not excluded - if not
684
# present it has been deleted so skip.
686
# From here down it was either not selected, or was excluded:
687
# We preserve the entry unaltered.
689
# Note: specific file commits after a merge are currently
690
# prohibited. This test is for sanity/safety in case it's
691
# required after that changes.
692
if len(self.parents) > 1:
694
self.builder.record_entry_contents(ie, self.parent_invs, path,
695
self.basis_tree, None)
697
def _report_and_accumulate_deletes(self):
698
if (isinstance(self.basis_inv, Inventory)
699
and isinstance(self.builder.new_inventory, Inventory)):
700
# the older Inventory classes provide a _byid dict, and building a
701
# set from the keys of this dict is substantially faster than even
702
# getting a set of ids from the inventory
704
# <lifeless> set(dict) is roughly the same speed as
705
# set(iter(dict)) and both are significantly slower than
707
deleted_ids = set(self.basis_inv._byid.keys()) - \
708
set(self.builder.new_inventory._byid.keys())
710
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
712
self.any_entries_deleted = True
713
deleted = [(self.basis_tree.id2path(file_id), file_id)
714
for file_id in deleted_ids]
716
# XXX: this is not quite directory-order sorting
717
for path, file_id in deleted:
718
self.builder.record_delete(path, file_id)
719
self.reporter.deleted(path)
732
721
def _check_strict(self):
733
722
# XXX: when we use iter_changes this would likely be faster if
738
727
for unknown in self.work_tree.unknowns():
739
728
raise StrictCommitFailed()
730
def _populate_from_inventory(self):
731
"""Populate the CommitBuilder by walking the working tree inventory."""
732
# Build the revision inventory.
734
# This starts by creating a new empty inventory. Depending on
735
# which files are selected for commit, and what is present in the
736
# current tree, the new inventory is populated. inventory entries
737
# which are candidates for modification have their revision set to
738
# None; inventory entries that are carried over untouched have their
739
# revision set to their prior value.
741
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
742
# results to create a new inventory at the same time, which results
743
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
746
specific_files = self.specific_files
747
exclude = self.exclude
748
report_changes = self.reporter.is_verbose()
750
# A tree of paths that have been deleted. E.g. if foo/bar has been
751
# deleted, then we have {'foo':{'bar':{}}}
753
# XXX: Note that entries may have the wrong kind because the entry does
754
# not reflect the status on disk.
755
work_inv = self.work_tree.inventory
756
# NB: entries will include entries within the excluded ids/paths
757
# because iter_entries_by_dir has no 'exclude' facility today.
758
entries = work_inv.iter_entries_by_dir(
759
specific_file_ids=self.specific_file_ids, yield_parents=True)
760
for path, existing_ie in entries:
761
file_id = existing_ie.file_id
762
name = existing_ie.name
763
parent_id = existing_ie.parent_id
764
kind = existing_ie.kind
765
# Skip files that have been deleted from the working tree.
766
# The deleted path ids are also recorded so they can be explicitly
769
path_segments = splitpath(path)
770
deleted_dict = deleted_paths
771
for segment in path_segments:
772
deleted_dict = deleted_dict.get(segment, None)
774
# We either took a path not present in the dict
775
# (deleted_dict was None), or we've reached an empty
776
# child dir in the dict, so are now a sub-path.
780
if deleted_dict is not None:
781
# the path has a deleted parent, do not add it.
783
if exclude and is_inside_any(exclude, path):
784
# Skip excluded paths. Excluded paths are processed by
785
# _update_builder_with_changes.
787
content_summary = self.work_tree.path_content_summary(path)
788
kind = content_summary[0]
789
# Note that when a filter of specific files is given, we must only
790
# skip/record deleted files matching that filter.
791
if not specific_files or is_inside_any(specific_files, path):
792
if kind == 'missing':
793
if not deleted_paths:
794
# path won't have been split yet.
795
path_segments = splitpath(path)
796
deleted_dict = deleted_paths
797
for segment in path_segments:
798
deleted_dict = deleted_dict.setdefault(segment, {})
799
self.reporter.missing(path)
800
self._next_progress_entry()
801
deleted_ids.append(file_id)
803
# TODO: have the builder do the nested commit just-in-time IF and
805
if kind == 'tree-reference':
806
# enforce repository nested tree policy.
807
if (not self.work_tree.supports_tree_reference() or
808
# repository does not support it either.
809
not self.branch.repository._format.supports_tree_reference):
811
content_summary = (kind, None, None, None)
812
elif self.recursive == 'down':
813
nested_revision_id = self._commit_nested_tree(
815
content_summary = (kind, None, None, nested_revision_id)
817
nested_revision_id = self.work_tree.get_reference_revision(file_id)
818
content_summary = (kind, None, None, nested_revision_id)
820
# Record an entry for this item
821
# Note: I don't particularly want to have the existing_ie
822
# parameter but the test suite currently (28-Jun-07) breaks
823
# without it thanks to a unicode normalisation issue. :-(
824
definitely_changed = kind != existing_ie.kind
825
self._record_entry(path, file_id, specific_files, kind, name,
826
parent_id, definitely_changed, existing_ie, report_changes,
829
# Unversion IDs that were found to be deleted
830
self.deleted_ids = deleted_ids
741
832
def _commit_nested_tree(self, file_id, path):
742
833
"Commit a nested tree."
743
sub_tree = self.work_tree.get_nested_tree(path, file_id)
834
sub_tree = self.work_tree.get_nested_tree(file_id, path)
744
835
# FIXME: be more comprehensive here:
745
836
# this works when both trees are in --trees repository,
746
837
# but when both are bound to a different repository,
760
851
allow_pointless=self.allow_pointless,
761
852
strict=self.strict, verbose=self.verbose,
762
853
local=self.local, reporter=self.reporter)
763
except PointlessCommit:
764
return self.work_tree.get_reference_revision(path, file_id)
854
except errors.PointlessCommit:
855
return self.work_tree.get_reference_revision(file_id)
857
def _record_entry(self, path, file_id, specific_files, kind, name,
858
parent_id, definitely_changed, existing_ie, report_changes,
860
"Record the new inventory entry for a path if any."
861
# mutter('check %s {%s}', path, file_id)
862
# mutter('%s selected for commit', path)
863
if definitely_changed or existing_ie is None:
864
ie = make_entry(kind, name, parent_id, file_id)
866
ie = existing_ie.copy()
868
# For carried over entries we don't care about the fs hash - the repo
869
# isn't generating a sha, so we're not saving computation time.
870
_, _, fs_hash = self.builder.record_entry_contents(
871
ie, self.parent_invs, path, self.work_tree, content_summary)
873
self._report_change(ie, path)
875
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
878
def _report_change(self, ie, path):
879
"""Report a change to the user.
881
The change that has occurred is described relative to the basis
884
if (self.basis_inv.has_id(ie.file_id)):
885
basis_ie = self.basis_inv[ie.file_id]
888
change = ie.describe_change(basis_ie, ie)
889
if change in (InventoryEntry.RENAMED,
890
InventoryEntry.MODIFIED_AND_RENAMED):
891
old_path = self.basis_inv.id2path(ie.file_id)
892
self.reporter.renamed(change, old_path, path)
893
self._next_progress_entry()
895
if change == 'unchanged':
897
self.reporter.snapshot_change(change, path)
898
self._next_progress_entry()
766
900
def _set_progress_stage(self, name, counter=False):
767
901
"""Set the progress stage and emit an update to the progress bar."""
781
915
def _emit_progress(self):
782
916
if self.pb_entries_count is not None:
783
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
917
text = "%s [%d] - Stage" % (self.pb_stage_name,
784
918
self.pb_entries_count)
786
text = gettext("%s - Stage") % (self.pb_stage_name, )
920
text = "%s - Stage" % (self.pb_stage_name, )
787
921
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
923
def _set_specific_file_ids(self):
924
"""populate self.specific_file_ids if we will use it."""
925
if not self.use_record_iter_changes:
926
# If provided, ensure the specified files are versioned
927
if self.specific_files is not None:
928
# Note: This routine is being called because it raises
929
# PathNotVersionedError as a side effect of finding the IDs. We
930
# later use the ids we found as input to the working tree
931
# inventory iterator, so we only consider those ids rather than
932
# examining the whole tree again.
933
# XXX: Dont we have filter_unversioned to do this more
935
self.specific_file_ids = tree.find_ids_across_trees(
936
self.specific_files, [self.basis_tree, self.work_tree])
938
self.specific_file_ids = None
added
removed
bzrlib/commit.py
