306
214
if message_callback is None:
307
215
if message is not None:
308
216
if isinstance(message, str):
309
message = message.decode(get_user_encoding())
217
message = message.decode(bzrlib.user_encoding)
310
218
message_callback = lambda x: message
312
220
raise BzrError("The message or message_callback keyword"
313
221
" parameter is required for commit().")
315
223
self.bound_branch = None
316
self.any_entries_deleted = False
317
if exclude is not None:
318
self.exclude = sorted(
319
minimum_path_selection(exclude))
322
224
self.local = local
323
225
self.master_branch = None
324
self.recursive = recursive
226
self.master_locked = False
325
227
self.rev_id = None
326
# self.specific_files is None to indicate no filter, or any iterable to
327
# indicate a filter - [] means no files at all, as per iter_changes.
328
if specific_files is not None:
329
self.specific_files = sorted(
330
minimum_path_selection(specific_files))
332
self.specific_files = None
228
self.specific_files = specific_files
334
229
self.allow_pointless = allow_pointless
230
self.recursive = recursive
231
self.revprops = revprops
335
232
self.message_callback = message_callback
336
233
self.timestamp = timestamp
337
234
self.timezone = timezone
338
235
self.committer = committer
236
self.specific_files = specific_files
339
237
self.strict = strict
340
238
self.verbose = verbose
241
if reporter is None and self.reporter is None:
242
self.reporter = NullCommitReporter()
243
elif reporter is not None:
244
self.reporter = reporter
342
246
self.work_tree.lock_write()
343
operation.add_cleanup(self.work_tree.unlock)
344
self.parents = self.work_tree.get_parent_ids()
345
# We can use record_iter_changes IFF iter_changes is compatible with
346
# the command line parameters, and the repository has fast delta
347
# generation. See bug 347649.
348
self.use_record_iter_changes = (
350
not self.branch.repository._format.supports_tree_reference and
351
(self.branch.repository._format.fast_deltas or
352
len(self.parents) < 2))
353
self.pb = ui.ui_factory.nested_progress_bar()
354
operation.add_cleanup(self.pb.finished)
355
self.basis_revid = self.work_tree.last_revision()
247
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
356
248
self.basis_tree = self.work_tree.basis_tree()
357
249
self.basis_tree.lock_read()
358
operation.add_cleanup(self.basis_tree.unlock)
359
# Cannot commit with conflicts present.
360
if len(self.work_tree.conflicts()) > 0:
361
raise ConflictsInTree
363
# Setup the bound branch variables as needed.
364
self._check_bound_branch(operation, possible_master_transports)
366
# Check that the working tree is up to date
367
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
369
# Complete configuration setup
370
if reporter is not None:
371
self.reporter = reporter
372
elif self.reporter is None:
373
self.reporter = self._select_reporter()
374
if self.config_stack is None:
375
self.config_stack = self.work_tree.get_config_stack()
377
self._set_specific_file_ids()
379
# Setup the progress bar. As the number of files that need to be
380
# committed in unknown, progress is reported as stages.
381
# We keep track of entries separately though and include that
382
# information in the progress bar during the relevant stages.
383
self.pb_stage_name = ""
384
self.pb_stage_count = 0
385
self.pb_stage_total = 5
386
if self.bound_branch:
387
# 2 extra stages: "Uploading data to master branch" and "Merging
388
# tags to master branch"
389
self.pb_stage_total += 2
390
self.pb.show_pct = False
391
self.pb.show_spinner = False
392
self.pb.show_eta = False
393
self.pb.show_count = True
394
self.pb.show_bar = True
396
self._gather_parents()
397
# After a merge, a selected file commit is not supported.
398
# See 'bzr help merge' for an explanation as to why.
399
if len(self.parents) > 1 and self.specific_files is not None:
400
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
401
# Excludes are a form of selected file commit.
402
if len(self.parents) > 1 and self.exclude:
403
raise errors.CannotCommitSelectedFileMerge(self.exclude)
405
# Collect the changes
406
self._set_progress_stage("Collecting changes", counter=True)
408
self.builder = self.branch.get_commit_builder(self.parents,
409
self.config_stack, timestamp, timezone, committer, self.revprops,
411
if not self.builder.supports_record_entry_contents and self.exclude:
413
raise errors.ExcludesUnsupported(self.branch.repository)
415
if self.builder.updates_branch and self.bound_branch:
417
raise AssertionError(
418
"bound branches not supported for commit builders "
419
"that update the branch")
422
self.builder.will_record_deletes()
423
# find the location being committed to
424
if self.bound_branch:
425
master_location = self.master_branch.base
251
# Cannot commit with conflicts present.
252
if len(self.work_tree.conflicts())>0:
253
raise ConflictsInTree
255
# setup the bound branch variables as needed.
256
self._check_bound_branch()
258
# check for out of date working trees
260
first_tree_parent = self.work_tree.get_parent_ids()[0]
262
# if there are no parents, treat our parent as 'None'
263
# this is so that we still consier the master branch
264
# - in a checkout scenario the tree may have no
265
# parents but the branch may do.
266
first_tree_parent = bzrlib.revision.NULL_REVISION
267
old_revno, master_last = self.master_branch.last_revision_info()
268
if master_last != first_tree_parent:
269
if master_last != bzrlib.revision.NULL_REVISION:
270
raise errors.OutOfDateTree(self.work_tree)
271
if self.branch.repository.has_revision(first_tree_parent):
272
new_revno = old_revno + 1
427
master_location = self.branch.base
429
# report the start of the commit
430
self.reporter.started(new_revno, self.rev_id, master_location)
432
self._update_builder_with_changes()
274
# ghost parents never appear in revision history.
277
# raise an exception as soon as we find a single unknown.
278
for unknown in self.work_tree.unknowns():
279
raise StrictCommitFailed()
281
if self.config is None:
282
self.config = self.branch.get_config()
284
self.work_inv = self.work_tree.inventory
285
self.basis_inv = self.basis_tree.inventory
286
if specific_files is not None:
287
# Ensure specified files are versioned
288
# (We don't actually need the ids here)
289
# XXX: Dont we have filter_unversioned to do this more
291
tree.find_ids_across_trees(specific_files,
292
[self.basis_tree, self.work_tree])
293
# one to finish, one for rev and inventory, and one for each
294
# inventory entry, and the same for the new inventory.
295
# note that this estimate is too long when we do a partial tree
296
# commit which excludes some new files from being considered.
297
# The estimate is corrected when we populate the new inv.
298
self.pb_total = len(self.work_inv) + 5
301
self._gather_parents()
302
if len(self.parents) > 1 and self.specific_files:
303
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
306
self.builder = self.branch.get_commit_builder(self.parents,
307
self.config, timestamp, timezone, committer, revprops, rev_id)
309
self._remove_deleted()
310
self._populate_new_inv()
311
self._report_deletes()
433
313
self._check_pointless()
435
# TODO: Now the new inventory is known, check for conflicts.
315
self._emit_progress_update()
316
# TODO: Now the new inventory is known, check for conflicts and
317
# prompt the user for a commit message.
436
318
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
437
319
# weave lines, because nothing should be recorded until it is known
438
320
# that commit will succeed.
439
self._set_progress_stage("Saving data locally")
440
321
self.builder.finish_inventory()
442
# Prompt the user for a commit message if none provided
322
self._emit_progress_update()
443
323
message = message_callback(self)
324
assert isinstance(message, unicode), type(message)
444
325
self.message = message
326
self._escape_commit_message()
446
# Add revision data to the local branch
447
328
self.rev_id = self.builder.commit(self.message)
450
mutter("aborting commit write group because of exception:")
451
trace.log_exception_quietly()
455
self._update_branches(old_revno, old_revid, new_revno)
457
# Make the working tree be up to date with the branch. This
458
# includes automatic changes scheduled to be made to the tree, such
459
# as updating its basis and unversioning paths that were missing.
460
self.work_tree.unversion(self.deleted_ids)
461
self._set_progress_stage("Updating the working tree")
462
self.work_tree.update_basis_by_delta(self.rev_id,
463
self.builder.get_basis_delta())
464
self.reporter.completed(new_revno, self.rev_id)
465
self._process_post_hooks(old_revno, new_revno)
468
def _update_branches(self, old_revno, old_revid, new_revno):
469
"""Update the master and local branch to the new revision.
471
This will try to make sure that the master branch is updated
472
before the local branch.
474
:param old_revno: Revision number of master branch before the
476
:param old_revid: Tip of master branch before the commit
477
:param new_revno: Revision number of the new commit
479
if not self.builder.updates_branch:
480
self._process_pre_hooks(old_revno, new_revno)
482
# Upload revision data to the master.
329
self._emit_progress_update()
330
# revision data is in the local branch now.
332
# upload revision data to the master.
483
333
# this will propagate merged revisions too if needed.
484
334
if self.bound_branch:
485
self._set_progress_stage("Uploading data to master branch")
486
# 'commit' to the master first so a timeout here causes the
487
# local branch to be out of date
488
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
489
self.branch, new_revno, self.rev_id, lossy=self._lossy)
491
self.branch.fetch(self.master_branch, self.rev_id)
335
self.master_branch.repository.fetch(self.branch.repository,
336
revision_id=self.rev_id)
337
# now the master has the revision data
338
# 'commit' to the master first so a timeout here causes the local
339
# branch to be out of date
340
self.master_branch.set_last_revision_info(new_revno,
493
343
# and now do the commit locally.
494
344
self.branch.set_last_revision_info(new_revno, self.rev_id)
497
self._process_pre_hooks(old_revno, new_revno)
499
# The commit builder will already have updated the branch,
501
self.branch.set_last_revision_info(old_revno, old_revid)
504
# Merge local tags to remote
505
if self.bound_branch:
506
self._set_progress_stage("Merging tags to master branch")
507
tag_updates, tag_conflicts = self.branch.tags.merge_to(
508
self.master_branch.tags)
510
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
511
note( gettext("Conflicting tags in bound branch:\n{0}".format(
512
"\n".join(warning_lines))) )
514
def _select_reporter(self):
515
"""Select the CommitReporter to use."""
517
return NullCommitReporter()
518
return ReportCommitToLog()
346
rev_tree = self.builder.revision_tree()
347
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
348
# now the work tree is up to date with the branch
350
self.reporter.completed(new_revno, self.rev_id)
351
# old style commit hooks - should be deprecated ? (obsoleted in
353
if self.config.post_commit() is not None:
354
hooks = self.config.post_commit().split(' ')
355
# this would be nicer with twisted.python.reflect.namedAny
357
result = eval(hook + '(branch, rev_id)',
358
{'branch':self.branch,
360
'rev_id':self.rev_id})
361
# new style commit hooks:
362
if not self.bound_branch:
363
hook_master = self.branch
366
hook_master = self.master_branch
367
hook_local = self.branch
368
# With bound branches, when the master is behind the local branch,
369
# the 'old_revno' and old_revid values here are incorrect.
370
# XXX: FIXME ^. RBC 20060206
372
old_revid = self.parents[0]
374
old_revid = bzrlib.revision.NULL_REVISION
375
for hook in Branch.hooks['post_commit']:
376
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
378
self._emit_progress_update()
383
def _any_real_changes(self):
384
"""Are there real changes between new_inventory and basis?
386
For trees without rich roots, inv.root.revision changes every commit.
387
But if that is the only change, we want to treat it as though there
390
new_entries = self.builder.new_inventory.iter_entries()
391
basis_entries = self.basis_inv.iter_entries()
392
new_path, new_root_ie = new_entries.next()
393
basis_path, basis_root_ie = basis_entries.next()
395
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
396
def ie_equal_no_revision(this, other):
397
return ((this.file_id == other.file_id)
398
and (this.name == other.name)
399
and (this.symlink_target == other.symlink_target)
400
and (this.text_sha1 == other.text_sha1)
401
and (this.text_size == other.text_size)
402
and (this.text_id == other.text_id)
403
and (this.parent_id == other.parent_id)
404
and (this.kind == other.kind)
405
and (this.executable == other.executable)
406
and (this.reference_revision == other.reference_revision)
408
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
411
for new_ie, basis_ie in zip(new_entries, basis_entries):
412
if new_ie != basis_ie:
415
# No actual changes present
520
418
def _check_pointless(self):
521
419
if self.allow_pointless:
568
475
# so grab the lock
569
476
self.bound_branch = self.branch
570
477
self.master_branch.lock_write()
571
operation.add_cleanup(self.master_branch.unlock)
573
def _check_out_of_date_tree(self):
574
"""Check that the working tree is up to date.
576
:return: old_revision_number, old_revision_id, new_revision_number
478
self.master_locked = True
481
"""Cleanup any open locks, progress bars etc."""
482
cleanups = [self._cleanup_bound_branch,
483
self.basis_tree.unlock,
484
self.work_tree.unlock,
486
found_exception = None
487
for cleanup in cleanups:
490
# we want every cleanup to run no matter what.
491
# so we have a catchall here, but we will raise the
492
# last encountered exception up the stack: and
493
# typically this will be useful enough.
496
if found_exception is not None:
497
# don't do a plan raise, because the last exception may have been
498
# trashed, e is our sure-to-work exception even though it loses the
499
# full traceback. XXX: RBC 20060421 perhaps we could check the
500
# exc_info and if its the same one do a plain raise otherwise
501
# 'raise e' as we do now.
504
def _cleanup_bound_branch(self):
505
"""Executed at the end of a try/finally to cleanup a bound branch.
507
If the branch wasn't bound, this is a no-op.
508
If it was, it resents self.branch to the local branch, instead
580
first_tree_parent = self.work_tree.get_parent_ids()[0]
582
# if there are no parents, treat our parent as 'None'
583
# this is so that we still consider the master branch
584
# - in a checkout scenario the tree may have no
585
# parents but the branch may do.
586
first_tree_parent = bzrlib.revision.NULL_REVISION
587
old_revno, master_last = self.master_branch.last_revision_info()
588
if master_last != first_tree_parent:
589
if master_last != bzrlib.revision.NULL_REVISION:
590
raise errors.OutOfDateTree(self.work_tree)
591
if self.branch.repository.has_revision(first_tree_parent):
592
new_revno = old_revno + 1
594
# ghost parents never appear in revision history.
596
return old_revno, master_last, new_revno
598
def _process_pre_hooks(self, old_revno, new_revno):
599
"""Process any registered pre commit hooks."""
600
self._set_progress_stage("Running pre_commit hooks")
601
self._process_hooks("pre_commit", old_revno, new_revno)
603
def _process_post_hooks(self, old_revno, new_revno):
604
"""Process any registered post commit hooks."""
605
# Process the post commit hooks, if any
606
self._set_progress_stage("Running post_commit hooks")
607
# old style commit hooks - should be deprecated ? (obsoleted in
608
# 0.15^H^H^H^H 2.5.0)
609
post_commit = self.config_stack.get('post_commit')
610
if post_commit is not None:
611
hooks = post_commit.split(' ')
612
# this would be nicer with twisted.python.reflect.namedAny
614
result = eval(hook + '(branch, rev_id)',
615
{'branch':self.branch,
617
'rev_id':self.rev_id})
618
# process new style post commit hooks
619
self._process_hooks("post_commit", old_revno, new_revno)
621
def _process_hooks(self, hook_name, old_revno, new_revno):
622
if not Branch.hooks[hook_name]:
625
# new style commit hooks:
626
511
if not self.bound_branch:
627
hook_master = self.branch
630
hook_master = self.master_branch
631
hook_local = self.branch
632
# With bound branches, when the master is behind the local branch,
633
# the 'old_revno' and old_revid values here are incorrect.
634
# XXX: FIXME ^. RBC 20060206
636
old_revid = self.parents[0]
638
old_revid = bzrlib.revision.NULL_REVISION
640
if hook_name == "pre_commit":
641
future_tree = self.builder.revision_tree()
642
tree_delta = future_tree.changes_from(self.basis_tree,
645
for hook in Branch.hooks[hook_name]:
646
# show the running hook in the progress bar. As hooks may
647
# end up doing nothing (e.g. because they are not configured by
648
# the user) this is still showing progress, not showing overall
649
# actions - its up to each plugin to show a UI if it want's to
650
# (such as 'Emailing diff to foo@example.com').
651
self.pb_stage_name = "Running %s hooks [%s]" % \
652
(hook_name, Branch.hooks.get_hook_name(hook))
653
self._emit_progress()
654
if 'hooks' in debug.debug_flags:
655
mutter("Invoking commit hook: %r", hook)
656
if hook_name == "post_commit":
657
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
659
elif hook_name == "pre_commit":
660
hook(hook_local, hook_master,
661
old_revno, old_revid, new_revno, self.rev_id,
662
tree_delta, future_tree)
513
if self.master_locked:
514
self.master_branch.unlock()
516
def _escape_commit_message(self):
517
"""Replace xml-incompatible control characters."""
518
# FIXME: RBC 20060419 this should be done by the revision
519
# serialiser not by commit. Then we can also add an unescaper
520
# in the deserializer and start roundtripping revision messages
521
# precisely. See repository_implementations/test_repository.py
523
# Python strings can include characters that can't be
524
# represented in well-formed XML; escape characters that
525
# aren't listed in the XML specification
526
# (http://www.w3.org/TR/REC-xml/#NT-Char).
527
self.message, escape_count = re.subn(
528
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
529
lambda match: match.group(0).encode('unicode_escape'),
532
self.reporter.escaped(escape_count, self.message)
664
534
def _gather_parents(self):
665
535
"""Record the parents of a merge for merge detection."""
666
# TODO: Make sure that this list doesn't contain duplicate
536
# TODO: Make sure that this list doesn't contain duplicate
667
537
# entries and the order is preserved when doing this.
668
if self.use_record_iter_changes:
670
self.basis_inv = self.basis_tree.root_inventory
538
self.parents = self.work_tree.get_parent_ids()
671
539
self.parent_invs = [self.basis_inv]
672
540
for revision in self.parents[1:]:
673
541
if self.branch.repository.has_revision(revision):
678
546
mutter('commit parent ghost revision {%s}', revision)
680
def _update_builder_with_changes(self):
681
"""Update the commit builder with the data about what has changed.
683
exclude = self.exclude
684
specific_files = self.specific_files
685
mutter("Selecting files for commit with filter %s", specific_files)
688
if self.use_record_iter_changes:
689
iter_changes = self.work_tree.iter_changes(self.basis_tree,
690
specific_files=specific_files)
691
iter_changes = self._filter_iter_changes(iter_changes)
692
for file_id, path, fs_hash in self.builder.record_iter_changes(
693
self.work_tree, self.basis_revid, iter_changes):
694
self.work_tree._observed_sha1(file_id, path, fs_hash)
696
# Build the new inventory
697
self._populate_from_inventory()
698
self._record_unselected()
699
self._report_and_accumulate_deletes()
701
def _filter_iter_changes(self, iter_changes):
702
"""Process iter_changes.
704
This method reports on the changes in iter_changes to the user, and
705
converts 'missing' entries in the iter_changes iterator to 'deleted'
706
entries. 'missing' entries have their
708
:param iter_changes: An iter_changes to process.
709
:return: A generator of changes.
711
reporter = self.reporter
712
report_changes = reporter.is_verbose()
548
def _remove_deleted(self):
549
"""Remove deleted files from the working inventories.
551
This is done prior to taking the working inventory as the
552
basis for the new committed inventory.
554
This returns true if any files
555
*that existed in the basis inventory* were deleted.
556
Files that were added and deleted
557
in the working copy don't matter.
559
specific = self.specific_files
714
for change in iter_changes:
716
old_path = change[1][0]
717
new_path = change[1][1]
718
versioned = change[3][1]
720
versioned = change[3][1]
721
if kind is None and versioned:
724
reporter.missing(new_path)
725
deleted_ids.append(change[0])
726
# Reset the new path (None) and new versioned flag (False)
727
change = (change[0], (change[1][0], None), change[2],
728
(change[3][0], False)) + change[4:]
729
new_path = change[1][1]
731
elif kind == 'tree-reference':
732
if self.recursive == 'down':
733
self._commit_nested_tree(change[0], change[1][1])
734
if change[3][0] or change[3][1]:
738
reporter.deleted(old_path)
739
elif old_path is None:
740
reporter.snapshot_change(gettext('added'), new_path)
741
elif old_path != new_path:
742
reporter.renamed(gettext('renamed'), old_path, new_path)
745
self.work_tree.branch.repository._format.rich_root_data):
746
# Don't report on changes to '' in non rich root
748
reporter.snapshot_change(gettext('modified'), new_path)
749
self._next_progress_entry()
750
# Unversion IDs that were found to be deleted
751
self.deleted_ids = deleted_ids
753
def _record_unselected(self):
754
# If specific files are selected, then all un-selected files must be
755
# recorded in their previous state. For more details, see
756
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
757
if self.specific_files or self.exclude:
758
specific_files = self.specific_files or []
759
for path, old_ie in self.basis_inv.iter_entries():
760
if self.builder.new_inventory.has_id(old_ie.file_id):
761
# already added - skip.
763
if (is_inside_any(specific_files, path)
764
and not is_inside_any(self.exclude, path)):
765
# was inside the selected path, and not excluded - if not
766
# present it has been deleted so skip.
768
# From here down it was either not selected, or was excluded:
769
# We preserve the entry unaltered.
771
# Note: specific file commits after a merge are currently
772
# prohibited. This test is for sanity/safety in case it's
773
# required after that changes.
774
if len(self.parents) > 1:
776
self.builder.record_entry_contents(ie, self.parent_invs, path,
777
self.basis_tree, None)
779
def _report_and_accumulate_deletes(self):
780
if (isinstance(self.basis_inv, Inventory)
781
and isinstance(self.builder.new_inventory, Inventory)):
782
# the older Inventory classes provide a _byid dict, and building a
783
# set from the keys of this dict is substantially faster than even
784
# getting a set of ids from the inventory
786
# <lifeless> set(dict) is roughly the same speed as
787
# set(iter(dict)) and both are significantly slower than
789
deleted_ids = set(self.basis_inv._byid.keys()) - \
790
set(self.builder.new_inventory._byid.keys())
792
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
794
self.any_entries_deleted = True
795
deleted = [(self.basis_tree.id2path(file_id), file_id)
796
for file_id in deleted_ids]
798
# XXX: this is not quite directory-order sorting
799
for path, file_id in deleted:
800
self.builder.record_delete(path, file_id)
801
self.reporter.deleted(path)
803
def _check_strict(self):
804
# XXX: when we use iter_changes this would likely be faster if
805
# iter_changes would check for us (even in the presence of
808
# raise an exception as soon as we find a single unknown.
809
for unknown in self.work_tree.unknowns():
810
raise StrictCommitFailed()
812
def _populate_from_inventory(self):
813
"""Populate the CommitBuilder by walking the working tree inventory."""
814
# Build the revision inventory.
816
# This starts by creating a new empty inventory. Depending on
817
# which files are selected for commit, and what is present in the
818
# current tree, the new inventory is populated. inventory entries
819
# which are candidates for modification have their revision set to
820
# None; inventory entries that are carried over untouched have their
821
# revision set to their prior value.
561
deleted_paths = set()
562
for path, ie in self.work_inv.iter_entries():
563
if is_inside_any(deleted_paths, path):
564
# The tree will delete the required ids recursively.
566
if specific and not is_inside_any(specific, path):
568
if not self.work_tree.has_filename(path):
569
deleted_paths.add(path)
570
self.reporter.missing(path)
571
deleted_ids.append(ie.file_id)
572
self.work_tree.unversion(deleted_ids)
574
def _populate_new_inv(self):
575
"""Build revision inventory.
577
This creates a new empty inventory. Depending on
578
which files are selected for commit, and what is present in the
579
current tree, the new inventory is populated. inventory entries
580
which are candidates for modification have their revision set to
581
None; inventory entries that are carried over untouched have their
582
revision set to their prior value.
823
584
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
824
585
# results to create a new inventory at the same time, which results
825
586
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
826
587
# ADHB 11-07-2006
828
specific_files = self.specific_files
829
exclude = self.exclude
830
report_changes = self.reporter.is_verbose()
832
# A tree of paths that have been deleted. E.g. if foo/bar has been
833
# deleted, then we have {'foo':{'bar':{}}}
835
# XXX: Note that entries may have the wrong kind because the entry does
836
# not reflect the status on disk.
837
# NB: entries will include entries within the excluded ids/paths
838
# because iter_entries_by_dir has no 'exclude' facility today.
839
entries = self.work_tree.iter_entries_by_dir(
840
specific_file_ids=self.specific_file_ids, yield_parents=True)
841
for path, existing_ie in entries:
842
file_id = existing_ie.file_id
843
name = existing_ie.name
844
parent_id = existing_ie.parent_id
845
kind = existing_ie.kind
846
# Skip files that have been deleted from the working tree.
847
# The deleted path ids are also recorded so they can be explicitly
850
path_segments = splitpath(path)
851
deleted_dict = deleted_paths
852
for segment in path_segments:
853
deleted_dict = deleted_dict.get(segment, None)
855
# We either took a path not present in the dict
856
# (deleted_dict was None), or we've reached an empty
857
# child dir in the dict, so are now a sub-path.
861
if deleted_dict is not None:
862
# the path has a deleted parent, do not add it.
864
if exclude and is_inside_any(exclude, path):
865
# Skip excluded paths. Excluded paths are processed by
866
# _update_builder_with_changes.
868
content_summary = self.work_tree.path_content_summary(path)
869
kind = content_summary[0]
870
# Note that when a filter of specific files is given, we must only
871
# skip/record deleted files matching that filter.
872
if not specific_files or is_inside_any(specific_files, path):
873
if kind == 'missing':
874
if not deleted_paths:
875
# path won't have been split yet.
876
path_segments = splitpath(path)
877
deleted_dict = deleted_paths
878
for segment in path_segments:
879
deleted_dict = deleted_dict.setdefault(segment, {})
880
self.reporter.missing(path)
881
self._next_progress_entry()
882
deleted_ids.append(file_id)
884
# TODO: have the builder do the nested commit just-in-time IF and
886
if kind == 'tree-reference':
887
# enforce repository nested tree policy.
888
if (not self.work_tree.supports_tree_reference() or
889
# repository does not support it either.
890
not self.branch.repository._format.supports_tree_reference):
892
content_summary = (kind, None, None, None)
893
elif self.recursive == 'down':
894
nested_revision_id = self._commit_nested_tree(
896
content_summary = (kind, None, None, nested_revision_id)
898
nested_revision_id = self.work_tree.get_reference_revision(file_id)
899
content_summary = (kind, None, None, nested_revision_id)
901
# Record an entry for this item
902
# Note: I don't particularly want to have the existing_ie
903
# parameter but the test suite currently (28-Jun-07) breaks
904
# without it thanks to a unicode normalisation issue. :-(
905
definitely_changed = kind != existing_ie.kind
906
self._record_entry(path, file_id, specific_files, kind, name,
907
parent_id, definitely_changed, existing_ie, report_changes,
910
# Unversion IDs that were found to be deleted
911
self.deleted_ids = deleted_ids
913
def _commit_nested_tree(self, file_id, path):
914
"Commit a nested tree."
915
sub_tree = self.work_tree.get_nested_tree(file_id, path)
916
# FIXME: be more comprehensive here:
917
# this works when both trees are in --trees repository,
918
# but when both are bound to a different repository,
919
# it fails; a better way of approaching this is to
920
# finally implement the explicit-caches approach design
921
# a while back - RBC 20070306.
922
if sub_tree.branch.repository.has_same_location(
923
self.work_tree.branch.repository):
924
sub_tree.branch.repository = \
925
self.work_tree.branch.repository
927
return sub_tree.commit(message=None, revprops=self.revprops,
928
recursive=self.recursive,
929
message_callback=self.message_callback,
930
timestamp=self.timestamp, timezone=self.timezone,
931
committer=self.committer,
932
allow_pointless=self.allow_pointless,
933
strict=self.strict, verbose=self.verbose,
934
local=self.local, reporter=self.reporter)
935
except errors.PointlessCommit:
936
return self.work_tree.get_reference_revision(file_id)
938
def _record_entry(self, path, file_id, specific_files, kind, name,
939
parent_id, definitely_changed, existing_ie, report_changes,
941
"Record the new inventory entry for a path if any."
942
# mutter('check %s {%s}', path, file_id)
943
# mutter('%s selected for commit', path)
944
if definitely_changed or existing_ie is None:
945
ie = make_entry(kind, name, parent_id, file_id)
947
ie = existing_ie.copy()
588
mutter("Selecting files for commit with filter %s", self.specific_files)
589
assert self.work_inv.root is not None
590
entries = self.work_inv.iter_entries()
591
if not self.builder.record_root_entry:
592
symbol_versioning.warn('CommitBuilders should support recording'
593
' the root entry as of bzr 0.10.', DeprecationWarning,
595
self.builder.new_inventory.add(self.basis_inv.root.copy())
597
self._emit_progress_update()
598
for path, new_ie in entries:
599
self._emit_progress_update()
600
file_id = new_ie.file_id
602
kind = self.work_tree.kind(file_id)
603
if kind == 'tree-reference' and self.recursive == 'down':
604
# nested tree: commit in it
605
sub_tree = WorkingTree.open(self.work_tree.abspath(path))
606
# FIXME: be more comprehensive here:
607
# this works when both trees are in --trees repository,
608
# but when both are bound to a different repository,
609
# it fails; a better way of approaching this is to
610
# finally implement the explicit-caches approach design
611
# a while back - RBC 20070306.
612
if (sub_tree.branch.repository.bzrdir.root_transport.base
614
self.work_tree.branch.repository.bzrdir.root_transport.base):
615
sub_tree.branch.repository = \
616
self.work_tree.branch.repository
618
sub_tree.commit(message=None, revprops=self.revprops,
619
recursive=self.recursive,
620
message_callback=self.message_callback,
621
timestamp=self.timestamp, timezone=self.timezone,
622
committer=self.committer,
623
allow_pointless=self.allow_pointless,
624
strict=self.strict, verbose=self.verbose,
625
local=self.local, reporter=self.reporter)
626
except errors.PointlessCommit:
628
if kind != new_ie.kind:
629
new_ie = inventory.make_entry(kind, new_ie.name,
630
new_ie.parent_id, file_id)
631
except errors.NoSuchFile:
633
# mutter('check %s {%s}', path, file_id)
634
if (not self.specific_files or
635
is_inside_or_parent_of_any(self.specific_files, path)):
636
# mutter('%s selected for commit', path)
640
# mutter('%s not selected for commit', path)
641
if self.basis_inv.has_id(file_id):
642
ie = self.basis_inv[file_id].copy()
644
# this entry is new and not being committed
646
self.builder.record_entry_contents(ie, self.parent_invs,
647
path, self.work_tree)
648
# describe the nature of the change that has occurred relative to
649
# the basis inventory.
650
if (self.basis_inv.has_id(ie.file_id)):
651
basis_ie = self.basis_inv[ie.file_id]
654
change = ie.describe_change(basis_ie, ie)
655
if change in (InventoryEntry.RENAMED,
656
InventoryEntry.MODIFIED_AND_RENAMED):
657
old_path = self.basis_inv.id2path(ie.file_id)
658
self.reporter.renamed(change, old_path, path)
660
self.reporter.snapshot_change(change, path)
662
if not self.specific_files:
665
# ignore removals that don't match filespec
666
for path, new_ie in self.basis_inv.iter_entries():
667
if new_ie.file_id in self.work_inv:
669
if is_inside_any(self.specific_files, path):
948
672
ie.revision = None
949
# For carried over entries we don't care about the fs hash - the repo
950
# isn't generating a sha, so we're not saving computation time.
951
_, _, fs_hash = self.builder.record_entry_contents(
952
ie, self.parent_invs, path, self.work_tree, content_summary)
954
self._report_change(ie, path)
956
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
959
def _report_change(self, ie, path):
960
"""Report a change to the user.
962
The change that has occurred is described relative to the basis
965
if (self.basis_inv.has_id(ie.file_id)):
966
basis_ie = self.basis_inv[ie.file_id]
969
change = ie.describe_change(basis_ie, ie)
970
if change in (InventoryEntry.RENAMED,
971
InventoryEntry.MODIFIED_AND_RENAMED):
972
old_path = self.basis_inv.id2path(ie.file_id)
973
self.reporter.renamed(change, old_path, path)
974
self._next_progress_entry()
976
if change == gettext('unchanged'):
978
self.reporter.snapshot_change(change, path)
979
self._next_progress_entry()
981
def _set_progress_stage(self, name, counter=False):
982
"""Set the progress stage and emit an update to the progress bar."""
983
self.pb_stage_name = name
984
self.pb_stage_count += 1
986
self.pb_entries_count = 0
988
self.pb_entries_count = None
989
self._emit_progress()
991
def _next_progress_entry(self):
992
"""Emit an update to the progress bar and increment the entry count."""
993
self.pb_entries_count += 1
994
self._emit_progress()
996
def _emit_progress(self):
997
if self.pb_entries_count is not None:
998
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
999
self.pb_entries_count)
1001
text = gettext("%s - Stage") % (self.pb_stage_name, )
1002
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
1004
def _set_specific_file_ids(self):
1005
"""populate self.specific_file_ids if we will use it."""
1006
if not self.use_record_iter_changes:
1007
# If provided, ensure the specified files are versioned
1008
if self.specific_files is not None:
1009
# Note: This routine is being called because it raises
1010
# PathNotVersionedError as a side effect of finding the IDs. We
1011
# later use the ids we found as input to the working tree
1012
# inventory iterator, so we only consider those ids rather than
1013
# examining the whole tree again.
1014
# XXX: Dont we have filter_unversioned to do this more
1016
self.specific_file_ids = tree.find_ids_across_trees(
1017
self.specific_files, [self.basis_tree, self.work_tree])
1019
self.specific_file_ids = None
673
self.builder.record_entry_contents(ie, self.parent_invs, path,
676
def _emit_progress_update(self):
677
"""Emit an update to the progress bar."""
678
self.pb.update("Committing", self.pb_count, self.pb_total)
681
def _report_deletes(self):
682
for path, ie in self.basis_inv.iter_entries():
683
if ie.file_id not in self.builder.new_inventory:
684
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
