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