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