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.
57
from cStringIO import StringIO
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 .urlutils import unescape_for_display
74
from .i18n import gettext
77
class PointlessCommit(BzrError):
79
_fmt = "No changes to commit"
82
class CannotCommitSelectedFileMerge(BzrError):
84
_fmt = 'Selected-file commit of merges is not supported yet:'\
85
' files %(files_str)s'
87
def __init__(self, files):
88
files_str = ', '.join(files)
89
BzrError.__init__(self, files=files, files_str=files_str)
92
def filter_excluded(iter_changes, exclude):
93
"""Filter exclude filenames.
95
:param iter_changes: iter_changes function
96
:param exclude: List of paths to exclude
97
:return: iter_changes function
99
for change in iter_changes:
100
old_path = change[1][0]
101
new_path = change[1][1]
103
new_excluded = (new_path is not None and
104
is_inside_any(exclude, new_path))
106
old_excluded = (old_path is not None and
107
is_inside_any(exclude, old_path))
109
if old_excluded and new_excluded:
112
if old_excluded or new_excluded:
113
# TODO(jelmer): Perhaps raise an error here instead?
67
from bzrlib.branch import Branch
68
from bzrlib.cleanup import OperationWithCleanups
70
from bzrlib.errors import (BzrError, PointlessCommit,
74
from bzrlib.osutils import (get_user_encoding,
75
kind_marker, isdir,isfile, is_inside_any,
76
is_inside_or_parent_of_any,
77
minimum_path_selection,
78
quotefn, sha_file, split_lines,
81
from bzrlib.testament import Testament
82
from bzrlib.trace import mutter, note, warning, is_quiet
83
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
84
from bzrlib import symbol_versioning
85
from bzrlib.symbol_versioning import (deprecated_passed,
88
from bzrlib.workingtree import WorkingTree
89
from bzrlib.urlutils import unescape_for_display
119
93
class NullCommitReporter(object):
120
94
"""I report on progress of a commit."""
122
def started(self, revno, revid, location):
96
def started(self, revno, revid, location=None):
98
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
99
"to started.", DeprecationWarning,
125
103
def snapshot_change(self, change, path):
151
129
note(format, *args)
153
131
def snapshot_change(self, change, path):
154
if path == '' and change in (gettext('added'), gettext('modified')):
132
if path == '' and change in ('added', 'modified'):
156
134
self._note("%s %s", change, path)
158
def started(self, revno, rev_id, location):
160
gettext('Committing to: %s'),
161
unescape_for_display(location, 'utf-8'))
136
def started(self, revno, rev_id, location=None):
137
if location is not None:
138
location = ' to: ' + unescape_for_display(location, 'utf-8')
140
# When started was added, location was only made optional by
141
# accident. Matt Nordhoff 20071129
142
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
143
"to started.", DeprecationWarning,
146
self._note('Committing%s', location)
163
148
def completed(self, revno, rev_id):
164
self._note(gettext('Committed revision %d.'), revno)
149
self._note('Committed revision %d.', revno)
165
150
# self._note goes to the console too; so while we want to log the
166
151
# rev_id, we can't trivially only log it. (See bug 526425). Long
167
152
# term we should rearrange the reporting structure, but for now
197
182
def __init__(self,
200
185
"""Create a Commit object.
202
187
:param reporter: the default reporter to use or None to decide later
204
189
self.reporter = reporter
205
self.config_stack = config_stack
208
def update_revprops(revprops, branch, authors=None,
209
local=False, possible_master_transports=None):
212
if possible_master_transports is None:
213
possible_master_transports = []
214
if (not u'branch-nick' in revprops and
215
branch.repository._format.supports_storing_branch_nick):
216
revprops[u'branch-nick'] = branch._get_nick(
218
possible_master_transports)
219
if authors is not None:
220
if u'author' in revprops or u'authors' in revprops:
221
# XXX: maybe we should just accept one of them?
222
raise AssertionError('author property given twice')
224
for individual in authors:
225
if '\n' in individual:
226
raise AssertionError('\\n is not a valid character '
227
'in an author identity')
228
revprops[u'authors'] = '\n'.join(authors)
303
261
message_callback=message_callback,
304
262
recursive=recursive,
306
possible_master_transports=possible_master_transports,
264
possible_master_transports=possible_master_transports)
309
266
def _commit(self, operation, message, timestamp, timezone, committer,
310
267
specific_files, rev_id, allow_pointless, strict, verbose,
311
268
working_tree, local, reporter, message_callback, recursive,
312
exclude, possible_master_transports, lossy):
269
exclude, possible_master_transports):
313
270
mutter('preparing to commit')
315
272
if working_tree is None:
391
358
self.pb_stage_count = 0
392
359
self.pb_stage_total = 5
393
360
if self.bound_branch:
394
# 2 extra stages: "Uploading data to master branch" and "Merging
395
# tags to master branch"
396
self.pb_stage_total += 2
361
self.pb_stage_total += 1
397
362
self.pb.show_pct = False
398
363
self.pb.show_spinner = False
399
364
self.pb.show_eta = False
400
365
self.pb.show_count = True
401
366
self.pb.show_bar = True
368
self._gather_parents()
403
369
# After a merge, a selected file commit is not supported.
404
370
# See 'bzr help merge' for an explanation as to why.
405
371
if len(self.parents) > 1 and self.specific_files is not None:
406
raise CannotCommitSelectedFileMerge(self.specific_files)
372
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
407
373
# Excludes are a form of selected file commit.
408
374
if len(self.parents) > 1 and self.exclude:
409
raise CannotCommitSelectedFileMerge(self.exclude)
375
raise errors.CannotCommitSelectedFileMerge(self.exclude)
411
377
# Collect the changes
412
378
self._set_progress_stage("Collecting changes", counter=True)
414
379
self.builder = self.branch.get_commit_builder(self.parents,
415
self.config_stack, timestamp, timezone, committer, self.revprops,
418
if self.builder.updates_branch and self.bound_branch:
420
raise AssertionError(
421
"bound branches not supported for commit builders "
422
"that update the branch")
380
self.config, timestamp, timezone, committer, self.revprops, rev_id)
383
self.builder.will_record_deletes()
425
384
# find the location being committed to
426
385
if self.bound_branch:
427
386
master_location = self.master_branch.base
448
407
# Add revision data to the local branch
449
408
self.rev_id = self.builder.commit(self.message)
451
except Exception as e:
452
411
mutter("aborting commit write group because of exception:")
453
412
trace.log_exception_quietly()
413
note("aborting commit write group: %r" % (e,))
454
414
self.builder.abort()
457
self._update_branches(old_revno, old_revid, new_revno)
417
self._process_pre_hooks(old_revno, new_revno)
419
# Upload revision data to the master.
420
# this will propagate merged revisions too if needed.
421
if self.bound_branch:
422
self._set_progress_stage("Uploading data to master branch")
423
# 'commit' to the master first so a timeout here causes the
424
# local branch to be out of date
425
self.master_branch.import_last_revision_info(
426
self.branch.repository, new_revno, self.rev_id)
428
# and now do the commit locally.
429
self.branch.set_last_revision_info(new_revno, self.rev_id)
459
431
# Make the working tree be up to date with the branch. This
460
432
# includes automatic changes scheduled to be made to the tree, such
461
433
# as updating its basis and unversioning paths that were missing.
462
self.work_tree.unversion(self.deleted_paths)
434
self.work_tree.unversion(self.deleted_ids)
463
435
self._set_progress_stage("Updating the working tree")
464
436
self.work_tree.update_basis_by_delta(self.rev_id,
465
437
self.builder.get_basis_delta())
467
439
self._process_post_hooks(old_revno, new_revno)
468
440
return self.rev_id
470
def _update_branches(self, old_revno, old_revid, new_revno):
471
"""Update the master and local branch to the new revision.
473
This will try to make sure that the master branch is updated
474
before the local branch.
476
:param old_revno: Revision number of master branch before the
478
:param old_revid: Tip of master branch before the commit
479
:param new_revno: Revision number of the new commit
481
if not self.builder.updates_branch:
482
self._process_pre_hooks(old_revno, new_revno)
484
# Upload revision data to the master.
485
# this will propagate merged revisions too if needed.
486
if self.bound_branch:
487
self._set_progress_stage("Uploading data to master branch")
488
# 'commit' to the master first so a timeout here causes the
489
# local branch to be out of date
490
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
491
self.branch, new_revno, self.rev_id, lossy=self._lossy)
493
self.branch.fetch(self.master_branch, self.rev_id)
495
# and now do the commit locally.
496
self.branch.set_last_revision_info(new_revno, self.rev_id)
499
self._process_pre_hooks(old_revno, new_revno)
501
# The commit builder will already have updated the branch,
503
self.branch.set_last_revision_info(old_revno, old_revid)
506
# Merge local tags to remote
507
if self.bound_branch:
508
self._set_progress_stage("Merging tags to master branch")
509
tag_updates, tag_conflicts = self.branch.tags.merge_to(
510
self.master_branch.tags)
512
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
513
note( gettext("Conflicting tags in bound branch:\n{0}".format(
514
"\n".join(warning_lines))) )
516
442
def _select_reporter(self):
517
443
"""Select the CommitReporter to use."""
585
519
# this is so that we still consider the master branch
586
520
# - in a checkout scenario the tree may have no
587
521
# parents but the branch may do.
588
first_tree_parent = breezy.revision.NULL_REVISION
522
first_tree_parent = bzrlib.revision.NULL_REVISION
589
523
old_revno, master_last = self.master_branch.last_revision_info()
590
524
if master_last != first_tree_parent:
591
if master_last != breezy.revision.NULL_REVISION:
525
if master_last != bzrlib.revision.NULL_REVISION:
592
526
raise errors.OutOfDateTree(self.work_tree)
593
527
if self.branch.repository.has_revision(first_tree_parent):
594
528
new_revno = old_revno + 1
596
530
# ghost parents never appear in revision history.
598
return old_revno, master_last, new_revno
532
return old_revno,new_revno
600
534
def _process_pre_hooks(self, old_revno, new_revno):
601
535
"""Process any registered pre commit hooks."""
663
596
old_revno, old_revid, new_revno, self.rev_id,
664
597
tree_delta, future_tree)
599
def _gather_parents(self):
600
"""Record the parents of a merge for merge detection."""
601
# TODO: Make sure that this list doesn't contain duplicate
602
# entries and the order is preserved when doing this.
603
if self.use_record_iter_changes:
605
self.basis_inv = self.basis_tree.inventory
606
self.parent_invs = [self.basis_inv]
607
for revision in self.parents[1:]:
608
if self.branch.repository.has_revision(revision):
609
mutter('commit parent revision {%s}', revision)
610
inventory = self.branch.repository.get_inventory(revision)
611
self.parent_invs.append(inventory)
613
mutter('commit parent ghost revision {%s}', revision)
666
615
def _update_builder_with_changes(self):
667
616
"""Update the commit builder with the data about what has changed.
618
exclude = self.exclude
669
619
specific_files = self.specific_files
670
mutter("Selecting files for commit with filter %r", specific_files)
620
mutter("Selecting files for commit with filter %s", specific_files)
672
622
self._check_strict()
673
iter_changes = self.work_tree.iter_changes(self.basis_tree,
674
specific_files=specific_files)
676
iter_changes = filter_excluded(iter_changes, self.exclude)
677
iter_changes = self._filter_iter_changes(iter_changes)
678
for file_id, path, fs_hash in self.builder.record_iter_changes(
679
self.work_tree, self.basis_revid, iter_changes):
680
self.work_tree._observed_sha1(file_id, path, fs_hash)
623
if self.use_record_iter_changes:
624
iter_changes = self.work_tree.iter_changes(self.basis_tree,
625
specific_files=specific_files)
626
iter_changes = self._filter_iter_changes(iter_changes)
627
for file_id, path, fs_hash in self.builder.record_iter_changes(
628
self.work_tree, self.basis_revid, iter_changes):
629
self.work_tree._observed_sha1(file_id, path, fs_hash)
631
# Build the new inventory
632
self._populate_from_inventory()
633
self._record_unselected()
634
self._report_and_accumulate_deletes()
682
636
def _filter_iter_changes(self, iter_changes):
683
637
"""Process iter_changes.
718
670
if new_path is None:
719
671
reporter.deleted(old_path)
720
672
elif old_path is None:
721
reporter.snapshot_change(gettext('added'), new_path)
673
reporter.snapshot_change('added', new_path)
722
674
elif old_path != new_path:
723
reporter.renamed(gettext('renamed'), old_path, new_path)
675
reporter.renamed('renamed', old_path, new_path)
726
678
self.work_tree.branch.repository._format.rich_root_data):
727
679
# Don't report on changes to '' in non rich root
729
reporter.snapshot_change(gettext('modified'), new_path)
681
reporter.snapshot_change('modified', new_path)
730
682
self._next_progress_entry()
731
# Unversion files that were found to be deleted
732
self.deleted_paths = deleted_paths
683
# Unversion IDs that were found to be deleted
684
self.deleted_ids = deleted_ids
686
def _record_unselected(self):
687
# If specific files are selected, then all un-selected files must be
688
# recorded in their previous state. For more details, see
689
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
690
if self.specific_files or self.exclude:
691
specific_files = self.specific_files or []
692
for path, old_ie in self.basis_inv.iter_entries():
693
if old_ie.file_id in self.builder.new_inventory:
694
# already added - skip.
696
if (is_inside_any(specific_files, path)
697
and not is_inside_any(self.exclude, path)):
698
# was inside the selected path, and not excluded - if not
699
# present it has been deleted so skip.
701
# From here down it was either not selected, or was excluded:
702
# We preserve the entry unaltered.
704
# Note: specific file commits after a merge are currently
705
# prohibited. This test is for sanity/safety in case it's
706
# required after that changes.
707
if len(self.parents) > 1:
709
self.builder.record_entry_contents(ie, self.parent_invs, path,
710
self.basis_tree, None)
712
def _report_and_accumulate_deletes(self):
713
if (isinstance(self.basis_inv, Inventory)
714
and isinstance(self.builder.new_inventory, Inventory)):
715
# the older Inventory classes provide a _byid dict, and building a
716
# set from the keys of this dict is substantially faster than even
717
# getting a set of ids from the inventory
719
# <lifeless> set(dict) is roughly the same speed as
720
# set(iter(dict)) and both are significantly slower than
722
deleted_ids = set(self.basis_inv._byid.keys()) - \
723
set(self.builder.new_inventory._byid.keys())
725
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
727
self.any_entries_deleted = True
728
deleted = [(self.basis_tree.id2path(file_id), file_id)
729
for file_id in deleted_ids]
731
# XXX: this is not quite directory-order sorting
732
for path, file_id in deleted:
733
self.builder.record_delete(path, file_id)
734
self.reporter.deleted(path)
734
736
def _check_strict(self):
735
737
# XXX: when we use iter_changes this would likely be faster if
740
742
for unknown in self.work_tree.unknowns():
741
743
raise StrictCommitFailed()
745
def _populate_from_inventory(self):
746
"""Populate the CommitBuilder by walking the working tree inventory."""
747
# Build the revision inventory.
749
# This starts by creating a new empty inventory. Depending on
750
# which files are selected for commit, and what is present in the
751
# current tree, the new inventory is populated. inventory entries
752
# which are candidates for modification have their revision set to
753
# None; inventory entries that are carried over untouched have their
754
# revision set to their prior value.
756
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
757
# results to create a new inventory at the same time, which results
758
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
761
specific_files = self.specific_files
762
exclude = self.exclude
763
report_changes = self.reporter.is_verbose()
765
# A tree of paths that have been deleted. E.g. if foo/bar has been
766
# deleted, then we have {'foo':{'bar':{}}}
768
# XXX: Note that entries may have the wrong kind because the entry does
769
# not reflect the status on disk.
770
work_inv = self.work_tree.inventory
771
# NB: entries will include entries within the excluded ids/paths
772
# because iter_entries_by_dir has no 'exclude' facility today.
773
entries = work_inv.iter_entries_by_dir(
774
specific_file_ids=self.specific_file_ids, yield_parents=True)
775
for path, existing_ie in entries:
776
file_id = existing_ie.file_id
777
name = existing_ie.name
778
parent_id = existing_ie.parent_id
779
kind = existing_ie.kind
780
# Skip files that have been deleted from the working tree.
781
# The deleted path ids are also recorded so they can be explicitly
784
path_segments = splitpath(path)
785
deleted_dict = deleted_paths
786
for segment in path_segments:
787
deleted_dict = deleted_dict.get(segment, None)
789
# We either took a path not present in the dict
790
# (deleted_dict was None), or we've reached an empty
791
# child dir in the dict, so are now a sub-path.
795
if deleted_dict is not None:
796
# the path has a deleted parent, do not add it.
798
if exclude and is_inside_any(exclude, path):
799
# Skip excluded paths. Excluded paths are processed by
800
# _update_builder_with_changes.
802
content_summary = self.work_tree.path_content_summary(path)
803
kind = content_summary[0]
804
# Note that when a filter of specific files is given, we must only
805
# skip/record deleted files matching that filter.
806
if not specific_files or is_inside_any(specific_files, path):
807
if kind == 'missing':
808
if not deleted_paths:
809
# path won't have been split yet.
810
path_segments = splitpath(path)
811
deleted_dict = deleted_paths
812
for segment in path_segments:
813
deleted_dict = deleted_dict.setdefault(segment, {})
814
self.reporter.missing(path)
815
self._next_progress_entry()
816
deleted_ids.append(file_id)
818
# TODO: have the builder do the nested commit just-in-time IF and
820
if kind == 'tree-reference':
821
# enforce repository nested tree policy.
822
if (not self.work_tree.supports_tree_reference() or
823
# repository does not support it either.
824
not self.branch.repository._format.supports_tree_reference):
826
content_summary = (kind, None, None, None)
827
elif self.recursive == 'down':
828
nested_revision_id = self._commit_nested_tree(
830
content_summary = (kind, None, None, nested_revision_id)
832
nested_revision_id = self.work_tree.get_reference_revision(file_id)
833
content_summary = (kind, None, None, nested_revision_id)
835
# Record an entry for this item
836
# Note: I don't particularly want to have the existing_ie
837
# parameter but the test suite currently (28-Jun-07) breaks
838
# without it thanks to a unicode normalisation issue. :-(
839
definitely_changed = kind != existing_ie.kind
840
self._record_entry(path, file_id, specific_files, kind, name,
841
parent_id, definitely_changed, existing_ie, report_changes,
844
# Unversion IDs that were found to be deleted
845
self.deleted_ids = deleted_ids
743
847
def _commit_nested_tree(self, file_id, path):
744
848
"Commit a nested tree."
745
sub_tree = self.work_tree.get_nested_tree(path, file_id)
849
sub_tree = self.work_tree.get_nested_tree(file_id, path)
746
850
# FIXME: be more comprehensive here:
747
851
# this works when both trees are in --trees repository,
748
852
# but when both are bound to a different repository,
762
866
allow_pointless=self.allow_pointless,
763
867
strict=self.strict, verbose=self.verbose,
764
868
local=self.local, reporter=self.reporter)
765
except PointlessCommit:
766
return self.work_tree.get_reference_revision(path, file_id)
869
except errors.PointlessCommit:
870
return self.work_tree.get_reference_revision(file_id)
872
def _record_entry(self, path, file_id, specific_files, kind, name,
873
parent_id, definitely_changed, existing_ie, report_changes,
875
"Record the new inventory entry for a path if any."
876
# mutter('check %s {%s}', path, file_id)
877
# mutter('%s selected for commit', path)
878
if definitely_changed or existing_ie is None:
879
ie = make_entry(kind, name, parent_id, file_id)
881
ie = existing_ie.copy()
883
# For carried over entries we don't care about the fs hash - the repo
884
# isn't generating a sha, so we're not saving computation time.
885
_, _, fs_hash = self.builder.record_entry_contents(
886
ie, self.parent_invs, path, self.work_tree, content_summary)
888
self._report_change(ie, path)
890
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
893
def _report_change(self, ie, path):
894
"""Report a change to the user.
896
The change that has occurred is described relative to the basis
899
if (self.basis_inv.has_id(ie.file_id)):
900
basis_ie = self.basis_inv[ie.file_id]
903
change = ie.describe_change(basis_ie, ie)
904
if change in (InventoryEntry.RENAMED,
905
InventoryEntry.MODIFIED_AND_RENAMED):
906
old_path = self.basis_inv.id2path(ie.file_id)
907
self.reporter.renamed(change, old_path, path)
908
self._next_progress_entry()
910
if change == 'unchanged':
912
self.reporter.snapshot_change(change, path)
913
self._next_progress_entry()
768
915
def _set_progress_stage(self, name, counter=False):
769
916
"""Set the progress stage and emit an update to the progress bar."""
783
930
def _emit_progress(self):
784
931
if self.pb_entries_count is not None:
785
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
932
text = "%s [%d] - Stage" % (self.pb_stage_name,
786
933
self.pb_entries_count)
788
text = gettext("%s - Stage") % (self.pb_stage_name, )
935
text = "%s - Stage" % (self.pb_stage_name, )
789
936
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
938
def _set_specific_file_ids(self):
939
"""populate self.specific_file_ids if we will use it."""
940
if not self.use_record_iter_changes:
941
# If provided, ensure the specified files are versioned
942
if self.specific_files is not None:
943
# Note: This routine is being called because it raises
944
# PathNotVersionedError as a side effect of finding the IDs. We
945
# later use the ids we found as input to the working tree
946
# inventory iterator, so we only consider those ids rather than
947
# examining the whole tree again.
948
# XXX: Dont we have filter_unversioned to do this more
950
self.specific_file_ids = tree.find_ids_across_trees(
951
self.specific_files, [self.basis_tree, self.work_tree])
953
self.specific_file_ids = None
added
removed
bzrlib/commit.py
