266
294
self.exclude = []
267
295
self.local = local
268
296
self.master_branch = None
269
self.master_locked = False
270
297
self.recursive = recursive
271
298
self.rev_id = None
299
# self.specific_files is None to indicate no filter, or any iterable to
300
# indicate a filter - [] means no files at all, as per iter_changes.
272
301
if specific_files is not None:
273
302
self.specific_files = sorted(
274
303
minimum_path_selection(specific_files))
276
305
self.specific_files = None
277
self.specific_file_ids = None
278
307
self.allow_pointless = allow_pointless
279
self.revprops = revprops
280
308
self.message_callback = message_callback
281
309
self.timestamp = timestamp
282
310
self.timezone = timezone
283
311
self.committer = committer
284
312
self.strict = strict
285
313
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
315
self.work_tree.lock_write()
316
operation.add_cleanup(self.work_tree.unlock)
317
self.parents = self.work_tree.get_parent_ids()
318
# We can use record_iter_changes IFF iter_changes is compatible with
319
# the command line parameters, and the repository has fast delta
320
# generation. See bug 347649.
321
self.use_record_iter_changes = (
323
not self.branch.repository._format.supports_tree_reference and
324
(self.branch.repository._format.fast_deltas or
325
len(self.parents) < 2))
291
326
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
327
operation.add_cleanup(self.pb.finished)
292
328
self.basis_revid = self.work_tree.last_revision()
293
329
self.basis_tree = self.work_tree.basis_tree()
294
330
self.basis_tree.lock_read()
331
operation.add_cleanup(self.basis_tree.unlock)
332
# Cannot commit with conflicts present.
333
if len(self.work_tree.conflicts()) > 0:
334
raise ConflictsInTree
336
# Setup the bound branch variables as needed.
337
self._check_bound_branch(operation, possible_master_transports)
339
# Check that the working tree is up to date
340
old_revno, new_revno = self._check_out_of_date_tree()
342
# Complete configuration setup
343
if reporter is not None:
344
self.reporter = reporter
345
elif self.reporter is None:
346
self.reporter = self._select_reporter()
347
if self.config is None:
348
self.config = self.branch.get_config()
350
self._set_specific_file_ids()
352
# Setup the progress bar. As the number of files that need to be
353
# committed in unknown, progress is reported as stages.
354
# We keep track of entries separately though and include that
355
# information in the progress bar during the relevant stages.
356
self.pb_stage_name = ""
357
self.pb_stage_count = 0
358
self.pb_stage_total = 5
359
if self.bound_branch:
360
self.pb_stage_total += 1
361
self.pb.show_pct = False
362
self.pb.show_spinner = False
363
self.pb.show_eta = False
364
self.pb.show_count = True
365
self.pb.show_bar = True
367
self._gather_parents()
368
# After a merge, a selected file commit is not supported.
369
# See 'bzr help merge' for an explanation as to why.
370
if len(self.parents) > 1 and self.specific_files is not None:
371
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
372
# Excludes are a form of selected file commit.
373
if len(self.parents) > 1 and self.exclude:
374
raise errors.CannotCommitSelectedFileMerge(self.exclude)
376
# Collect the changes
377
self._set_progress_stage("Collecting changes", counter=True)
378
self.builder = self.branch.get_commit_builder(self.parents,
379
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)
382
self.builder.will_record_deletes()
383
# find the location being committed to
384
if self.bound_branch:
385
master_location = self.master_branch.base
387
master_location = self.branch.base
389
# report the start of the commit
390
self.reporter.started(new_revno, self.rev_id, master_location)
392
self._update_builder_with_changes()
393
self._check_pointless()
395
# TODO: Now the new inventory is known, check for conflicts.
396
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
397
# weave lines, because nothing should be recorded until it is known
398
# that commit will succeed.
399
self._set_progress_stage("Saving data locally")
400
self.builder.finish_inventory()
402
# Prompt the user for a commit message if none provided
403
message = message_callback(self)
404
self.message = message
406
# Add revision data to the local branch
407
self.rev_id = self.builder.commit(self.message)
410
mutter("aborting commit write group because of exception:")
411
trace.log_exception_quietly()
412
note("aborting commit write group: %r" % (e,))
416
self._process_pre_hooks(old_revno, new_revno)
418
# Upload revision data to the master.
419
# this will propagate merged revisions too if needed.
420
if self.bound_branch:
421
self._set_progress_stage("Uploading data to master branch")
422
# 'commit' to the master first so a timeout here causes the
423
# local branch to be out of date
424
self.master_branch.import_last_revision_info(
425
self.branch.repository, new_revno, self.rev_id)
427
# and now do the commit locally.
428
self.branch.set_last_revision_info(new_revno, self.rev_id)
430
# Make the working tree be up to date with the branch. This
431
# includes automatic changes scheduled to be made to the tree, such
432
# as updating its basis and unversioning paths that were missing.
433
self.work_tree.unversion(self.deleted_ids)
434
self._set_progress_stage("Updating the working tree")
435
self.work_tree.update_basis_by_delta(self.rev_id,
436
self.builder.get_basis_delta())
437
self.reporter.completed(new_revno, self.rev_id)
438
self._process_post_hooks(old_revno, new_revno)
417
439
return self.rev_id
419
441
def _select_reporter(self):
575
595
old_revno, old_revid, new_revno, self.rev_id,
576
596
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
598
def _gather_parents(self):
633
599
"""Record the parents of a merge for merge detection."""
634
# TODO: Make sure that this list doesn't contain duplicate
600
# TODO: Make sure that this list doesn't contain duplicate
635
601
# entries and the order is preserved when doing this.
636
self.parents = self.work_tree.get_parent_ids()
602
if self.use_record_iter_changes:
604
self.basis_inv = self.basis_tree.inventory
637
605
self.parent_invs = [self.basis_inv]
638
606
for revision in self.parents[1:]:
639
607
if self.branch.repository.has_revision(revision):
646
614
def _update_builder_with_changes(self):
647
615
"""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
617
exclude = self.exclude
664
specific_files = self.specific_files or []
618
specific_files = self.specific_files
665
619
mutter("Selecting files for commit with filter %s", specific_files)
667
# Build the new inventory
668
self._populate_from_inventory()
622
if self.use_record_iter_changes:
623
iter_changes = self.work_tree.iter_changes(self.basis_tree,
624
specific_files=specific_files)
625
iter_changes = self._filter_iter_changes(iter_changes)
626
for file_id, path, fs_hash in self.builder.record_iter_changes(
627
self.work_tree, self.basis_revid, iter_changes):
628
self.work_tree._observed_sha1(file_id, path, fs_hash)
630
# Build the new inventory
631
self._populate_from_inventory()
632
self._record_unselected()
633
self._report_and_accumulate_deletes()
635
def _filter_iter_changes(self, iter_changes):
636
"""Process iter_changes.
638
This method reports on the changes in iter_changes to the user, and
639
converts 'missing' entries in the iter_changes iterator to 'deleted'
640
entries. 'missing' entries have their
642
:param iter_changes: An iter_changes to process.
643
:return: A generator of changes.
645
reporter = self.reporter
646
report_changes = reporter.is_verbose()
648
for change in iter_changes:
650
old_path = change[1][0]
651
new_path = change[1][1]
652
versioned = change[3][1]
654
versioned = change[3][1]
655
if kind is None and versioned:
658
reporter.missing(new_path)
659
deleted_ids.append(change[0])
660
# Reset the new path (None) and new versioned flag (False)
661
change = (change[0], (change[1][0], None), change[2],
662
(change[3][0], False)) + change[4:]
663
elif kind == 'tree-reference':
664
if self.recursive == 'down':
665
self._commit_nested_tree(change[0], change[1][1])
666
if change[3][0] or change[3][1]:
670
reporter.deleted(old_path)
671
elif old_path is None:
672
reporter.snapshot_change('added', new_path)
673
elif old_path != new_path:
674
reporter.renamed('renamed', old_path, new_path)
677
self.work_tree.branch.repository._format.rich_root_data):
678
# Don't report on changes to '' in non rich root
680
reporter.snapshot_change('modified', new_path)
681
self._next_progress_entry()
682
# Unversion IDs that were found to be deleted
683
self.deleted_ids = deleted_ids
685
def _record_unselected(self):
670
686
# If specific files are selected, then all un-selected files must be
671
687
# recorded in their previous state. For more details, see
672
688
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
673
if specific_files or exclude:
689
if self.specific_files or self.exclude:
690
specific_files = self.specific_files or []
674
691
for path, old_ie in self.basis_inv.iter_entries():
675
692
if old_ie.file_id in self.builder.new_inventory:
676
693
# already added - skip.
678
695
if (is_inside_any(specific_files, path)
679
and not is_inside_any(exclude, path)):
696
and not is_inside_any(self.exclude, path)):
680
697
# was inside the selected path, and not excluded - if not
681
698
# present it has been deleted so skip.
683
700
# From here down it was either not selected, or was excluded:
684
if old_ie.kind == 'directory':
685
self._next_progress_entry()
686
701
# We preserve the entry unaltered.
687
702
ie = old_ie.copy()
688
703
# Note: specific file commits after a merge are currently
added
removed
bzrlib/commit.py
