266
295
self.exclude = []
267
296
self.local = local
268
297
self.master_branch = None
269
self.master_locked = False
270
298
self.recursive = recursive
271
299
self.rev_id = None
300
# self.specific_files is None to indicate no filter, or any iterable to
301
# indicate a filter - [] means no files at all, as per iter_changes.
272
302
if specific_files is not None:
273
303
self.specific_files = sorted(
274
304
minimum_path_selection(specific_files))
276
306
self.specific_files = None
277
self.specific_file_ids = None
278
308
self.allow_pointless = allow_pointless
279
self.revprops = revprops
280
309
self.message_callback = message_callback
281
310
self.timestamp = timestamp
282
311
self.timezone = timezone
283
312
self.committer = committer
284
313
self.strict = strict
285
314
self.verbose = verbose
286
# accumulates an inventory delta to the basis entry, so we can make
287
# just the necessary updates to the workingtree's cached basis.
288
self._basis_delta = []
290
316
self.work_tree.lock_write()
317
operation.add_cleanup(self.work_tree.unlock)
318
self.parents = self.work_tree.get_parent_ids()
319
# We can use record_iter_changes IFF iter_changes is compatible with
320
# the command line parameters, and the repository has fast delta
321
# generation. See bug 347649.
322
self.use_record_iter_changes = (
324
not self.branch.repository._format.supports_tree_reference and
325
(self.branch.repository._format.fast_deltas or
326
len(self.parents) < 2))
291
327
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
328
operation.add_cleanup(self.pb.finished)
292
329
self.basis_revid = self.work_tree.last_revision()
293
330
self.basis_tree = self.work_tree.basis_tree()
294
331
self.basis_tree.lock_read()
332
operation.add_cleanup(self.basis_tree.unlock)
333
# Cannot commit with conflicts present.
334
if len(self.work_tree.conflicts()) > 0:
335
raise ConflictsInTree
337
# Setup the bound branch variables as needed.
338
self._check_bound_branch(operation, possible_master_transports)
340
# Check that the working tree is up to date
341
old_revno, new_revno = self._check_out_of_date_tree()
343
# Complete configuration setup
344
if reporter is not None:
345
self.reporter = reporter
346
elif self.reporter is None:
347
self.reporter = self._select_reporter()
348
if self.config is None:
349
self.config = self.branch.get_config()
351
self._set_specific_file_ids()
353
# Setup the progress bar. As the number of files that need to be
354
# committed in unknown, progress is reported as stages.
355
# We keep track of entries separately though and include that
356
# information in the progress bar during the relevant stages.
357
self.pb_stage_name = ""
358
self.pb_stage_count = 0
359
self.pb_stage_total = 5
360
if self.bound_branch:
361
self.pb_stage_total += 1
362
self.pb.show_pct = False
363
self.pb.show_spinner = False
364
self.pb.show_eta = False
365
self.pb.show_count = True
366
self.pb.show_bar = True
368
self._gather_parents()
369
# After a merge, a selected file commit is not supported.
370
# See 'bzr help merge' for an explanation as to why.
371
if len(self.parents) > 1 and self.specific_files is not None:
372
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
373
# Excludes are a form of selected file commit.
374
if len(self.parents) > 1 and self.exclude:
375
raise errors.CannotCommitSelectedFileMerge(self.exclude)
377
# Collect the changes
378
self._set_progress_stage("Collecting changes", counter=True)
379
self.builder = self.branch.get_commit_builder(self.parents,
380
self.config, timestamp, timezone, committer, self.revprops, rev_id)
296
# Cannot commit with conflicts present.
297
if len(self.work_tree.conflicts()) > 0:
298
raise ConflictsInTree
300
# Setup the bound branch variables as needed.
301
self._check_bound_branch()
303
# Check that the working tree is up to date
304
old_revno, new_revno = self._check_out_of_date_tree()
306
# Complete configuration setup
307
if reporter is not None:
308
self.reporter = reporter
309
elif self.reporter is None:
310
self.reporter = self._select_reporter()
311
if self.config is None:
312
self.config = self.branch.get_config()
314
# If provided, ensure the specified files are versioned
315
if self.specific_files is not None:
316
# Note: This routine is being called because it raises
317
# PathNotVersionedError as a side effect of finding the IDs. We
318
# later use the ids we found as input to the working tree
319
# inventory iterator, so we only consider those ids rather than
320
# examining the whole tree again.
321
# XXX: Dont we have filter_unversioned to do this more
323
self.specific_file_ids = tree.find_ids_across_trees(
324
specific_files, [self.basis_tree, self.work_tree])
326
# Setup the progress bar. As the number of files that need to be
327
# committed in unknown, progress is reported as stages.
328
# We keep track of entries separately though and include that
329
# information in the progress bar during the relevant stages.
330
self.pb_stage_name = ""
331
self.pb_stage_count = 0
332
self.pb_stage_total = 5
333
if self.bound_branch:
334
self.pb_stage_total += 1
335
self.pb.show_pct = False
336
self.pb.show_spinner = False
337
self.pb.show_eta = False
338
self.pb.show_count = True
339
self.pb.show_bar = True
341
self.basis_inv = self.basis_tree.inventory
342
self._gather_parents()
343
# After a merge, a selected file commit is not supported.
344
# See 'bzr help merge' for an explanation as to why.
345
if len(self.parents) > 1 and self.specific_files:
346
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
347
# Excludes are a form of selected file commit.
348
if len(self.parents) > 1 and self.exclude:
349
raise errors.CannotCommitSelectedFileMerge(self.exclude)
351
# Collect the changes
352
self._set_progress_stage("Collecting changes",
353
entries_title="Directory")
354
self.builder = self.branch.get_commit_builder(self.parents,
355
self.config, timestamp, timezone, committer, revprops, rev_id)
358
# find the location being committed to
359
if self.bound_branch:
360
master_location = self.master_branch.base
362
master_location = self.branch.base
364
# report the start of the commit
365
self.reporter.started(new_revno, self.rev_id, master_location)
367
self._update_builder_with_changes()
368
self._report_and_accumulate_deletes()
369
self._check_pointless()
371
# TODO: Now the new inventory is known, check for conflicts.
372
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
373
# weave lines, because nothing should be recorded until it is known
374
# that commit will succeed.
375
self._set_progress_stage("Saving data locally")
376
self.builder.finish_inventory()
378
# Prompt the user for a commit message if none provided
379
message = message_callback(self)
380
self.message = message
381
self._escape_commit_message()
383
# Add revision data to the local branch
384
self.rev_id = self.builder.commit(self.message)
390
self._process_pre_hooks(old_revno, new_revno)
392
# Upload revision data to the master.
393
# this will propagate merged revisions too if needed.
394
if self.bound_branch:
395
if not self.master_branch.repository.has_same_location(
396
self.branch.repository):
397
self._set_progress_stage("Uploading data to master branch")
398
self.master_branch.repository.fetch(self.branch.repository,
399
revision_id=self.rev_id)
400
# now the master has the revision data
401
# 'commit' to the master first so a timeout here causes the
402
# local branch to be out of date
403
self.master_branch.set_last_revision_info(new_revno,
406
# and now do the commit locally.
407
self.branch.set_last_revision_info(new_revno, self.rev_id)
409
# Make the working tree up to date with the branch
410
self._set_progress_stage("Updating the working tree")
411
self.work_tree.update_basis_by_delta(self.rev_id,
413
self.reporter.completed(new_revno, self.rev_id)
414
self._process_post_hooks(old_revno, new_revno)
383
self.builder.will_record_deletes()
384
# find the location being committed to
385
if self.bound_branch:
386
master_location = self.master_branch.base
388
master_location = self.branch.base
390
# report the start of the commit
391
self.reporter.started(new_revno, self.rev_id, master_location)
393
self._update_builder_with_changes()
394
self._check_pointless()
396
# TODO: Now the new inventory is known, check for conflicts.
397
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
398
# weave lines, because nothing should be recorded until it is known
399
# that commit will succeed.
400
self._set_progress_stage("Saving data locally")
401
self.builder.finish_inventory()
403
# Prompt the user for a commit message if none provided
404
message = message_callback(self)
405
self.message = message
407
# Add revision data to the local branch
408
self.rev_id = self.builder.commit(self.message)
411
mutter("aborting commit write group because of exception:")
412
trace.log_exception_quietly()
413
note("aborting commit write group: %r" % (e,))
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)
431
# Make the working tree be up to date with the branch. This
432
# includes automatic changes scheduled to be made to the tree, such
433
# as updating its basis and unversioning paths that were missing.
434
self.work_tree.unversion(self.deleted_ids)
435
self._set_progress_stage("Updating the working tree")
436
self.work_tree.update_basis_by_delta(self.rev_id,
437
self.builder.get_basis_delta())
438
self.reporter.completed(new_revno, self.rev_id)
439
self._process_post_hooks(old_revno, new_revno)
417
440
return self.rev_id
419
442
def _select_reporter(self):
575
596
old_revno, old_revid, new_revno, self.rev_id,
576
597
tree_delta, future_tree)
579
"""Cleanup any open locks, progress bars etc."""
580
cleanups = [self._cleanup_bound_branch,
581
self.basis_tree.unlock,
582
self.work_tree.unlock,
584
found_exception = None
585
for cleanup in cleanups:
588
# we want every cleanup to run no matter what.
589
# so we have a catchall here, but we will raise the
590
# last encountered exception up the stack: and
591
# typically this will be useful enough.
594
if found_exception is not None:
595
# don't do a plan raise, because the last exception may have been
596
# trashed, e is our sure-to-work exception even though it loses the
597
# full traceback. XXX: RBC 20060421 perhaps we could check the
598
# exc_info and if its the same one do a plain raise otherwise
599
# 'raise e' as we do now.
602
def _cleanup_bound_branch(self):
603
"""Executed at the end of a try/finally to cleanup a bound branch.
605
If the branch wasn't bound, this is a no-op.
606
If it was, it resents self.branch to the local branch, instead
609
if not self.bound_branch:
611
if self.master_locked:
612
self.master_branch.unlock()
614
def _escape_commit_message(self):
615
"""Replace xml-incompatible control characters."""
616
# FIXME: RBC 20060419 this should be done by the revision
617
# serialiser not by commit. Then we can also add an unescaper
618
# in the deserializer and start roundtripping revision messages
619
# precisely. See repository_implementations/test_repository.py
621
# Python strings can include characters that can't be
622
# represented in well-formed XML; escape characters that
623
# aren't listed in the XML specification
624
# (http://www.w3.org/TR/REC-xml/#NT-Char).
625
self.message, escape_count = re.subn(
626
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
627
lambda match: match.group(0).encode('unicode_escape'),
630
self.reporter.escaped(escape_count, self.message)
632
599
def _gather_parents(self):
633
600
"""Record the parents of a merge for merge detection."""
634
# TODO: Make sure that this list doesn't contain duplicate
601
# TODO: Make sure that this list doesn't contain duplicate
635
602
# entries and the order is preserved when doing this.
636
self.parents = self.work_tree.get_parent_ids()
603
if self.use_record_iter_changes:
605
self.basis_inv = self.basis_tree.inventory
637
606
self.parent_invs = [self.basis_inv]
638
607
for revision in self.parents[1:]:
639
608
if self.branch.repository.has_revision(revision):
646
615
def _update_builder_with_changes(self):
647
616
"""Update the commit builder with the data about what has changed.
649
# Build the revision inventory.
651
# This starts by creating a new empty inventory. Depending on
652
# which files are selected for commit, and what is present in the
653
# current tree, the new inventory is populated. inventory entries
654
# which are candidates for modification have their revision set to
655
# None; inventory entries that are carried over untouched have their
656
# revision set to their prior value.
658
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
659
# results to create a new inventory at the same time, which results
660
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
663
618
exclude = self.exclude
664
specific_files = self.specific_files or []
619
specific_files = self.specific_files
665
620
mutter("Selecting files for commit with filter %s", specific_files)
667
# Build the new inventory
668
self._populate_from_inventory()
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()
636
def _filter_iter_changes(self, iter_changes):
637
"""Process iter_changes.
639
This method reports on the changes in iter_changes to the user, and
640
converts 'missing' entries in the iter_changes iterator to 'deleted'
641
entries. 'missing' entries have their
643
:param iter_changes: An iter_changes to process.
644
:return: A generator of changes.
646
reporter = self.reporter
647
report_changes = reporter.is_verbose()
649
for change in iter_changes:
651
old_path = change[1][0]
652
new_path = change[1][1]
653
versioned = change[3][1]
655
versioned = change[3][1]
656
if kind is None and versioned:
659
reporter.missing(new_path)
660
deleted_ids.append(change[0])
661
# Reset the new path (None) and new versioned flag (False)
662
change = (change[0], (change[1][0], None), change[2],
663
(change[3][0], False)) + change[4:]
664
elif kind == 'tree-reference':
665
if self.recursive == 'down':
666
self._commit_nested_tree(change[0], change[1][1])
667
if change[3][0] or change[3][1]:
671
reporter.deleted(old_path)
672
elif old_path is None:
673
reporter.snapshot_change('added', new_path)
674
elif old_path != new_path:
675
reporter.renamed('renamed', old_path, new_path)
678
self.work_tree.branch.repository._format.rich_root_data):
679
# Don't report on changes to '' in non rich root
681
reporter.snapshot_change('modified', new_path)
682
self._next_progress_entry()
683
# Unversion IDs that were found to be deleted
684
self.deleted_ids = deleted_ids
686
def _record_unselected(self):
670
687
# If specific files are selected, then all un-selected files must be
671
688
# recorded in their previous state. For more details, see
672
689
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
673
if specific_files or exclude:
690
if self.specific_files or self.exclude:
691
specific_files = self.specific_files or []
674
692
for path, old_ie in self.basis_inv.iter_entries():
675
693
if old_ie.file_id in self.builder.new_inventory:
676
694
# already added - skip.
678
696
if (is_inside_any(specific_files, path)
679
and not is_inside_any(exclude, path)):
697
and not is_inside_any(self.exclude, path)):
680
698
# was inside the selected path, and not excluded - if not
681
699
# present it has been deleted so skip.
683
701
# From here down it was either not selected, or was excluded:
684
if old_ie.kind == 'directory':
685
self._next_progress_entry()
686
702
# We preserve the entry unaltered.
687
703
ie = old_ie.copy()
688
704
# Note: specific file commits after a merge are currently
added
removed
bzrlib/commit.py
