274
306
self.committer = committer
275
307
self.strict = strict
276
308
self.verbose = verbose
277
# accumulates an inventory delta to the basis entry, so we can make
278
# just the necessary updates to the workingtree's cached basis.
279
self._basis_delta = []
281
310
self.work_tree.lock_write()
311
operation.add_cleanup(self.work_tree.unlock)
312
self.parents = self.work_tree.get_parent_ids()
313
# We can use record_iter_changes IFF iter_changes is compatible with
314
# the command line parameters, and the repository has fast delta
315
# generation. See bug 347649.
316
self.use_record_iter_changes = (
318
not self.branch.repository._format.supports_tree_reference and
319
(self.branch.repository._format.fast_deltas or
320
len(self.parents) < 2))
282
321
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
322
operation.add_cleanup(self.pb.finished)
283
323
self.basis_revid = self.work_tree.last_revision()
284
324
self.basis_tree = self.work_tree.basis_tree()
285
325
self.basis_tree.lock_read()
326
operation.add_cleanup(self.basis_tree.unlock)
327
# Cannot commit with conflicts present.
328
if len(self.work_tree.conflicts()) > 0:
329
raise ConflictsInTree
331
# Setup the bound branch variables as needed.
332
self._check_bound_branch(operation, possible_master_transports)
334
# Check that the working tree is up to date
335
old_revno, new_revno = self._check_out_of_date_tree()
337
# Complete configuration setup
338
if reporter is not None:
339
self.reporter = reporter
340
elif self.reporter is None:
341
self.reporter = self._select_reporter()
342
if self.config is None:
343
self.config = self.branch.get_config()
345
self._set_specific_file_ids()
347
# Setup the progress bar. As the number of files that need to be
348
# committed in unknown, progress is reported as stages.
349
# We keep track of entries separately though and include that
350
# information in the progress bar during the relevant stages.
351
self.pb_stage_name = ""
352
self.pb_stage_count = 0
353
self.pb_stage_total = 5
354
if self.bound_branch:
355
self.pb_stage_total += 1
356
self.pb.show_pct = False
357
self.pb.show_spinner = False
358
self.pb.show_eta = False
359
self.pb.show_count = True
360
self.pb.show_bar = True
362
self._gather_parents()
363
# After a merge, a selected file commit is not supported.
364
# See 'bzr help merge' for an explanation as to why.
365
if len(self.parents) > 1 and self.specific_files is not None:
366
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
367
# Excludes are a form of selected file commit.
368
if len(self.parents) > 1 and self.exclude:
369
raise errors.CannotCommitSelectedFileMerge(self.exclude)
371
# Collect the changes
372
self._set_progress_stage("Collecting changes", counter=True)
373
self.builder = self.branch.get_commit_builder(self.parents,
374
self.config, timestamp, timezone, committer, revprops, rev_id)
287
# Cannot commit with conflicts present.
288
if len(self.work_tree.conflicts()) > 0:
289
raise ConflictsInTree
291
# Setup the bound branch variables as needed.
292
self._check_bound_branch()
294
# Check that the working tree is up to date
295
old_revno, new_revno = self._check_out_of_date_tree()
297
# Complete configuration setup
298
if reporter is not None:
299
self.reporter = reporter
300
elif self.reporter is None:
301
self.reporter = self._select_reporter()
302
if self.config is None:
303
self.config = self.branch.get_config()
305
# If provided, ensure the specified files are versioned
306
if self.specific_files is not None:
307
# Note: This routine is being called because it raises
308
# PathNotVersionedError as a side effect of finding the IDs. We
309
# later use the ids we found as input to the working tree
310
# inventory iterator, so we only consider those ids rather than
311
# examining the whole tree again.
312
# XXX: Dont we have filter_unversioned to do this more
314
self.specific_file_ids = tree.find_ids_across_trees(
315
specific_files, [self.basis_tree, self.work_tree])
317
# Setup the progress bar. As the number of files that need to be
318
# committed in unknown, progress is reported as stages.
319
# We keep track of entries separately though and include that
320
# information in the progress bar during the relevant stages.
321
self.pb_stage_name = ""
322
self.pb_stage_count = 0
323
self.pb_stage_total = 5
324
if self.bound_branch:
325
self.pb_stage_total += 1
326
self.pb.show_pct = False
327
self.pb.show_spinner = False
328
self.pb.show_eta = False
329
self.pb.show_count = True
330
self.pb.show_bar = True
332
# After a merge, a selected file commit is not supported.
333
# See 'bzr help merge' for an explanation as to why.
334
self.basis_inv = self.basis_tree.inventory
335
self._gather_parents()
336
if len(self.parents) > 1 and self.specific_files:
337
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
339
# Collect the changes
340
self._set_progress_stage("Collecting changes",
341
entries_title="Directory")
342
self.builder = self.branch.get_commit_builder(self.parents,
343
self.config, timestamp, timezone, committer, revprops, rev_id)
346
# find the location being committed to
347
if self.bound_branch:
348
master_location = self.master_branch.base
350
master_location = self.branch.base
352
# report the start of the commit
353
self.reporter.started(new_revno, self.rev_id, master_location)
355
self._update_builder_with_changes()
356
self._report_and_accumulate_deletes()
357
self._check_pointless()
359
# TODO: Now the new inventory is known, check for conflicts.
360
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
361
# weave lines, because nothing should be recorded until it is known
362
# that commit will succeed.
363
self._set_progress_stage("Saving data locally")
364
self.builder.finish_inventory()
366
# Prompt the user for a commit message if none provided
367
message = message_callback(self)
368
self.message = message
369
self._escape_commit_message()
371
# Add revision data to the local branch
372
self.rev_id = self.builder.commit(self.message)
378
self._process_pre_hooks(old_revno, new_revno)
380
# Upload revision data to the master.
381
# this will propagate merged revisions too if needed.
382
if self.bound_branch:
383
if not self.master_branch.repository.has_same_location(
384
self.branch.repository):
385
self._set_progress_stage("Uploading data to master branch")
386
self.master_branch.repository.fetch(self.branch.repository,
387
revision_id=self.rev_id)
388
# now the master has the revision data
389
# 'commit' to the master first so a timeout here causes the
390
# local branch to be out of date
391
self.master_branch.set_last_revision_info(new_revno,
394
# and now do the commit locally.
395
self.branch.set_last_revision_info(new_revno, self.rev_id)
397
# Make the working tree up to date with the branch
398
self._set_progress_stage("Updating the working tree")
399
self.work_tree.update_basis_by_delta(self.rev_id,
401
self.reporter.completed(new_revno, self.rev_id)
402
self._process_post_hooks(old_revno, new_revno)
377
self.builder.will_record_deletes()
378
# find the location being committed to
379
if self.bound_branch:
380
master_location = self.master_branch.base
382
master_location = self.branch.base
384
# report the start of the commit
385
self.reporter.started(new_revno, self.rev_id, master_location)
387
self._update_builder_with_changes()
388
self._check_pointless()
390
# TODO: Now the new inventory is known, check for conflicts.
391
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
392
# weave lines, because nothing should be recorded until it is known
393
# that commit will succeed.
394
self._set_progress_stage("Saving data locally")
395
self.builder.finish_inventory()
397
# Prompt the user for a commit message if none provided
398
message = message_callback(self)
399
self.message = message
401
# Add revision data to the local branch
402
self.rev_id = self.builder.commit(self.message)
405
mutter("aborting commit write group because of exception:")
406
trace.log_exception_quietly()
407
note("aborting commit write group: %r" % (e,))
411
self._process_pre_hooks(old_revno, new_revno)
413
# Upload revision data to the master.
414
# this will propagate merged revisions too if needed.
415
if self.bound_branch:
416
self._set_progress_stage("Uploading data to master branch")
417
# 'commit' to the master first so a timeout here causes the
418
# local branch to be out of date
419
self.master_branch.import_last_revision_info(
420
self.branch.repository, new_revno, self.rev_id)
422
# and now do the commit locally.
423
self.branch.set_last_revision_info(new_revno, self.rev_id)
425
# Make the working tree be up to date with the branch. This
426
# includes automatic changes scheduled to be made to the tree, such
427
# as updating its basis and unversioning paths that were missing.
428
self.work_tree.unversion(self.deleted_ids)
429
self._set_progress_stage("Updating the working tree")
430
self.work_tree.update_basis_by_delta(self.rev_id,
431
self.builder.get_basis_delta())
432
self.reporter.completed(new_revno, self.rev_id)
433
self._process_post_hooks(old_revno, new_revno)
405
434
return self.rev_id
407
436
def _select_reporter(self):
563
590
old_revno, old_revid, new_revno, self.rev_id,
564
591
tree_delta, future_tree)
567
"""Cleanup any open locks, progress bars etc."""
568
cleanups = [self._cleanup_bound_branch,
569
self.basis_tree.unlock,
570
self.work_tree.unlock,
572
found_exception = None
573
for cleanup in cleanups:
576
# we want every cleanup to run no matter what.
577
# so we have a catchall here, but we will raise the
578
# last encountered exception up the stack: and
579
# typically this will be useful enough.
582
if found_exception is not None:
583
# don't do a plan raise, because the last exception may have been
584
# trashed, e is our sure-to-work exception even though it loses the
585
# full traceback. XXX: RBC 20060421 perhaps we could check the
586
# exc_info and if its the same one do a plain raise otherwise
587
# 'raise e' as we do now.
590
def _cleanup_bound_branch(self):
591
"""Executed at the end of a try/finally to cleanup a bound branch.
593
If the branch wasn't bound, this is a no-op.
594
If it was, it resents self.branch to the local branch, instead
597
if not self.bound_branch:
599
if self.master_locked:
600
self.master_branch.unlock()
602
def _escape_commit_message(self):
603
"""Replace xml-incompatible control characters."""
604
# FIXME: RBC 20060419 this should be done by the revision
605
# serialiser not by commit. Then we can also add an unescaper
606
# in the deserializer and start roundtripping revision messages
607
# precisely. See repository_implementations/test_repository.py
609
# Python strings can include characters that can't be
610
# represented in well-formed XML; escape characters that
611
# aren't listed in the XML specification
612
# (http://www.w3.org/TR/REC-xml/#NT-Char).
613
self.message, escape_count = re.subn(
614
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
615
lambda match: match.group(0).encode('unicode_escape'),
618
self.reporter.escaped(escape_count, self.message)
620
593
def _gather_parents(self):
621
594
"""Record the parents of a merge for merge detection."""
622
# TODO: Make sure that this list doesn't contain duplicate
595
# TODO: Make sure that this list doesn't contain duplicate
623
596
# entries and the order is preserved when doing this.
624
self.parents = self.work_tree.get_parent_ids()
597
if self.use_record_iter_changes:
599
self.basis_inv = self.basis_tree.inventory
625
600
self.parent_invs = [self.basis_inv]
626
601
for revision in self.parents[1:]:
627
602
if self.branch.repository.has_revision(revision):
634
609
def _update_builder_with_changes(self):
635
610
"""Update the commit builder with the data about what has changed.
637
# Build the revision inventory.
639
# This starts by creating a new empty inventory. Depending on
640
# which files are selected for commit, and what is present in the
641
# current tree, the new inventory is populated. inventory entries
642
# which are candidates for modification have their revision set to
643
# None; inventory entries that are carried over untouched have their
644
# revision set to their prior value.
646
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
647
# results to create a new inventory at the same time, which results
648
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
612
exclude = self.exclude
651
613
specific_files = self.specific_files
652
614
mutter("Selecting files for commit with filter %s", specific_files)
654
# Build the new inventory
655
self._populate_from_inventory(specific_files)
617
if self.use_record_iter_changes:
618
iter_changes = self.work_tree.iter_changes(self.basis_tree,
619
specific_files=specific_files)
620
iter_changes = self._filter_iter_changes(iter_changes)
621
for file_id, path, fs_hash in self.builder.record_iter_changes(
622
self.work_tree, self.basis_revid, iter_changes):
623
self.work_tree._observed_sha1(file_id, path, fs_hash)
625
# Build the new inventory
626
self._populate_from_inventory()
627
self._record_unselected()
628
self._report_and_accumulate_deletes()
630
def _filter_iter_changes(self, iter_changes):
631
"""Process iter_changes.
633
This method reports on the changes in iter_changes to the user, and
634
converts 'missing' entries in the iter_changes iterator to 'deleted'
635
entries. 'missing' entries have their
637
:param iter_changes: An iter_changes to process.
638
:return: A generator of changes.
640
reporter = self.reporter
641
report_changes = reporter.is_verbose()
643
for change in iter_changes:
645
old_path = change[1][0]
646
new_path = change[1][1]
647
versioned = change[3][1]
649
versioned = change[3][1]
650
if kind is None and versioned:
653
reporter.missing(new_path)
654
deleted_ids.append(change[0])
655
# Reset the new path (None) and new versioned flag (False)
656
change = (change[0], (change[1][0], None), change[2],
657
(change[3][0], False)) + change[4:]
658
elif kind == 'tree-reference':
659
if self.recursive == 'down':
660
self._commit_nested_tree(change[0], change[1][1])
661
if change[3][0] or change[3][1]:
665
reporter.deleted(old_path)
666
elif old_path is None:
667
reporter.snapshot_change('added', new_path)
668
elif old_path != new_path:
669
reporter.renamed('renamed', old_path, new_path)
672
self.work_tree.branch.repository._format.rich_root_data):
673
# Don't report on changes to '' in non rich root
675
reporter.snapshot_change('modified', new_path)
676
self._next_progress_entry()
677
# Unversion IDs that were found to be deleted
678
self.deleted_ids = deleted_ids
680
def _record_unselected(self):
657
681
# If specific files are selected, then all un-selected files must be
658
682
# recorded in their previous state. For more details, see
659
683
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
684
if self.specific_files or self.exclude:
685
specific_files = self.specific_files or []
661
686
for path, old_ie in self.basis_inv.iter_entries():
662
687
if old_ie.file_id in self.builder.new_inventory:
663
688
# already added - skip.
665
if is_inside_any(specific_files, path):
666
# was inside the selected path, if not present it has been
690
if (is_inside_any(specific_files, path)
691
and not is_inside_any(self.exclude, path)):
692
# was inside the selected path, and not excluded - if not
693
# present it has been deleted so skip.
669
if old_ie.kind == 'directory':
670
self._next_progress_entry()
671
# not in final inv yet, was not in the selected files, so is an
672
# entry to be preserved unaltered.
695
# From here down it was either not selected, or was excluded:
696
# We preserve the entry unaltered.
673
697
ie = old_ie.copy()
674
698
# Note: specific file commits after a merge are currently
675
699
# prohibited. This test is for sanity/safety in case it's
676
700
# required after that changes.
677
701
if len(self.parents) > 1:
678
702
ie.revision = None
679
delta, version_recorded = self.builder.record_entry_contents(
680
ie, self.parent_invs, path, self.basis_tree, None)
682
self.any_entries_changed = True
683
if delta: self._basis_delta.append(delta)
703
self.builder.record_entry_contents(ie, self.parent_invs, path,
704
self.basis_tree, None)
685
706
def _report_and_accumulate_deletes(self):
686
# XXX: Could the list of deleted paths and ids be instead taken from
687
# _populate_from_inventory?
688
deleted_ids = set(self.basis_inv._byid.keys()) - \
689
set(self.builder.new_inventory._byid.keys())
707
if (isinstance(self.basis_inv, Inventory)
708
and isinstance(self.builder.new_inventory, Inventory)):
709
# the older Inventory classes provide a _byid dict, and building a
710
# set from the keys of this dict is substantially faster than even
711
# getting a set of ids from the inventory
713
# <lifeless> set(dict) is roughly the same speed as
714
# set(iter(dict)) and both are significantly slower than
716
deleted_ids = set(self.basis_inv._byid.keys()) - \
717
set(self.builder.new_inventory._byid.keys())
719
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
691
721
self.any_entries_deleted = True
692
722
deleted = [(self.basis_tree.id2path(file_id), file_id)
751
806
for segment in path_segments:
752
807
deleted_dict = deleted_dict.setdefault(segment, {})
753
808
self.reporter.missing(path)
809
self._next_progress_entry()
754
810
deleted_ids.append(file_id)
756
812
# TODO: have the builder do the nested commit just-in-time IF and
757
813
# only if needed.
758
if content_summary[0] == 'tree-reference':
814
if kind == 'tree-reference':
759
815
# enforce repository nested tree policy.
760
816
if (not self.work_tree.supports_tree_reference() or
761
817
# repository does not support it either.
762
818
not self.branch.repository._format.supports_tree_reference):
763
content_summary = ('directory',) + content_summary[1:]
764
kind = content_summary[0]
765
# TODO: specific_files filtering before nested tree processing
766
if kind == 'tree-reference':
767
if self.recursive == 'down':
820
content_summary = (kind, None, None, None)
821
elif self.recursive == 'down':
768
822
nested_revision_id = self._commit_nested_tree(
770
content_summary = content_summary[:3] + (
824
content_summary = (kind, None, None, nested_revision_id)
773
content_summary = content_summary[:3] + (
774
self.work_tree.get_reference_revision(file_id),)
826
nested_revision_id = self.work_tree.get_reference_revision(file_id)
827
content_summary = (kind, None, None, nested_revision_id)
776
829
# Record an entry for this item
777
830
# Note: I don't particularly want to have the existing_ie
865
922
self._emit_progress()
867
924
def _emit_progress(self):
868
if self.pb_entries_title:
869
if self.pb_entries_total == '?':
870
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
871
self.pb_entries_title, self.pb_entries_count)
873
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
874
self.pb_entries_title, self.pb_entries_count,
875
str(self.pb_entries_total))
925
if self.pb_entries_count is not None:
926
text = "%s [%d] - Stage" % (self.pb_stage_name,
927
self.pb_entries_count)
877
text = "%s - Stage" % (self.pb_stage_name)
929
text = "%s - Stage" % (self.pb_stage_name, )
878
930
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
932
def _set_specific_file_ids(self):
933
"""populate self.specific_file_ids if we will use it."""
934
if not self.use_record_iter_changes:
935
# If provided, ensure the specified files are versioned
936
if self.specific_files is not None:
937
# Note: This routine is being called because it raises
938
# PathNotVersionedError as a side effect of finding the IDs. We
939
# later use the ids we found as input to the working tree
940
# inventory iterator, so we only consider those ids rather than
941
# examining the whole tree again.
942
# XXX: Dont we have filter_unversioned to do this more
944
self.specific_file_ids = tree.find_ids_across_trees(
945
self.specific_files, [self.basis_tree, self.work_tree])
947
self.specific_file_ids = None
added
removed
bzrlib/commit.py
