182
225
working_tree=None,
229
message_callback=None,
232
possible_master_transports=None,
186
234
"""Commit working copy as a new revision.
188
branch -- the deprecated branch to commit to. New callers should pass in
191
message -- the commit message, a mandatory parameter
193
timestamp -- if not None, seconds-since-epoch for a
194
postdated/predated commit.
196
specific_files -- If true, commit only those files.
198
rev_id -- If set, use this as the new revision id.
236
:param message: the commit message (it or message_callback is required)
237
:param message_callback: A callback: message = message_callback(cmt_obj)
239
:param timestamp: if not None, seconds-since-epoch for a
240
postdated/predated commit.
242
:param specific_files: If not None, commit only those files. An empty
243
list means 'commit no files'.
245
:param rev_id: If set, use this as the new revision id.
199
246
Useful for test or import commands that need to tightly
200
247
control what revisions are assigned. If you duplicate
201
248
a revision id that exists elsewhere it is your own fault.
202
249
If null (default), a time/random revision id is generated.
204
allow_pointless -- If true (default), commit even if nothing
251
:param allow_pointless: If true (default), commit even if nothing
205
252
has changed and no merges are recorded.
207
strict -- If true, don't allow a commit if the working tree
254
:param strict: If true, don't allow a commit if the working tree
208
255
contains unknown files.
210
revprops -- Properties for new revision
257
:param revprops: Properties for new revision
211
258
:param local: Perform a local only commit.
259
:param reporter: the reporter to use or None for the default
260
:param verbose: if True and the reporter is not None, report everything
261
:param recursive: If set to 'down', commit in any subtrees that have
262
pending changes of any sort during this commit.
263
:param exclude: None or a list of relative paths to exclude from the
264
commit. Pending changes to excluded files will be ignored by the
266
:param lossy: When committing to a foreign VCS, ignore any
267
data that can not be natively represented.
269
operation = OperationWithCleanups(self._commit)
270
self.revprops = revprops or {}
271
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
272
self.config_stack = config or self.config_stack
273
return operation.run(
278
specific_files=specific_files,
280
allow_pointless=allow_pointless,
283
working_tree=working_tree,
286
message_callback=message_callback,
289
possible_master_transports=possible_master_transports,
292
def _commit(self, operation, message, timestamp, timezone, committer,
293
specific_files, rev_id, allow_pointless, strict, verbose,
294
working_tree, local, reporter, message_callback, recursive,
295
exclude, possible_master_transports, lossy):
213
296
mutter('preparing to commit')
215
if deprecated_passed(branch):
216
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
217
"deprecated as of bzr 0.8. Please use working_tree= instead.",
218
DeprecationWarning, stacklevel=2)
220
self.work_tree = self.branch.bzrdir.open_workingtree()
221
elif working_tree is None:
222
raise BzrError("One of branch and working_tree must be passed into commit().")
298
if working_tree is None:
299
raise BzrError("working_tree must be passed into commit().")
224
301
self.work_tree = working_tree
225
302
self.branch = self.work_tree.branch
227
raise BzrError("The message keyword parameter is required for commit().")
303
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
304
if not self.branch.repository.supports_rich_root():
305
raise errors.RootNotRich()
306
if message_callback is None:
307
if message is not None:
308
if isinstance(message, str):
309
message = message.decode(get_user_encoding())
310
message_callback = lambda x: message
312
raise BzrError("The message or message_callback keyword"
313
" parameter is required for commit().")
229
315
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))
230
322
self.local = local
231
323
self.master_branch = None
232
self.master_locked = False
324
self.recursive = recursive
233
325
self.rev_id = None
234
self.specific_files = specific_files
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
235
334
self.allow_pointless = allow_pointless
237
if reporter is None and self.reporter is None:
238
self.reporter = NullCommitReporter()
239
elif reporter is not None:
240
self.reporter = reporter
335
self.message_callback = message_callback
336
self.timestamp = timestamp
337
self.timezone = timezone
338
self.committer = committer
340
self.verbose = verbose
242
342
self.work_tree.lock_write()
243
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
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()
356
self.basis_tree = self.work_tree.basis_tree()
357
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")
245
# Cannot commit with conflicts present.
246
if len(self.work_tree.conflicts())>0:
247
raise ConflictsInTree
249
# setup the bound branch variables as needed.
250
self._check_bound_branch()
252
# check for out of date working trees
254
first_tree_parent = self.work_tree.get_parent_ids()[0]
256
# if there are no parents, treat our parent as 'None'
257
# this is so that we still consier the master branch
258
# - in a checkout scenario the tree may have no
259
# parents but the branch may do.
260
first_tree_parent = None
261
master_last = self.master_branch.last_revision()
262
if (master_last is not None and
263
master_last != first_tree_parent):
264
raise errors.OutOfDateTree(self.work_tree)
267
# raise an exception as soon as we find a single unknown.
268
for unknown in self.work_tree.unknowns():
269
raise StrictCommitFailed()
271
if self.config is None:
272
self.config = self.branch.get_config()
274
if isinstance(message, str):
275
message = message.decode(bzrlib.user_encoding)
276
assert isinstance(message, unicode), type(message)
277
self.message = message
278
self._escape_commit_message()
280
self.work_inv = self.work_tree.inventory
281
self.basis_tree = self.work_tree.basis_tree()
282
self.basis_inv = self.basis_tree.inventory
283
if specific_files is not None:
284
# Ensure specified files are versioned
285
# (We don't actually need the ids here)
286
tree.find_ids_across_trees(specific_files,
287
[self.basis_tree, self.work_tree])
288
# one to finish, one for rev and inventory, and one for each
289
# inventory entry, and the same for the new inventory.
290
# note that this estimate is too long when we do a partial tree
291
# commit which excludes some new files from being considered.
292
# The estimate is corrected when we populate the new inv.
293
self.pb_total = len(self.work_inv) + 5
296
self._gather_parents()
297
if len(self.parents) > 1 and self.specific_files:
298
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
301
self.builder = self.branch.get_commit_builder(self.parents,
302
self.config, timestamp, timezone, committer, revprops, rev_id)
304
self._remove_deleted()
305
self._populate_new_inv()
306
self._report_deletes()
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
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()
308
433
self._check_pointless()
310
self._emit_progress_update()
311
# TODO: Now the new inventory is known, check for conflicts and
312
# prompt the user for a commit message.
435
# TODO: Now the new inventory is known, check for conflicts.
313
436
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
314
437
# weave lines, because nothing should be recorded until it is known
315
438
# that commit will succeed.
439
self._set_progress_stage("Saving data locally")
316
440
self.builder.finish_inventory()
317
self._emit_progress_update()
442
# Prompt the user for a commit message if none provided
443
message = message_callback(self)
444
self.message = message
446
# Add revision data to the local branch
318
447
self.rev_id = self.builder.commit(self.message)
319
self._emit_progress_update()
320
# revision data is in the local branch now.
322
# upload revision data to the master.
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.
323
483
# this will propagate merged revisions too if needed.
324
484
if self.bound_branch:
325
self.master_branch.repository.fetch(self.branch.repository,
326
revision_id=self.rev_id)
327
# now the master has the revision data
328
# 'commit' to the master first so a timeout here causes the local
329
# branch to be out of date
330
self.master_branch.append_revision(self.rev_id)
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)
332
493
# and now do the commit locally.
333
self.branch.append_revision(self.rev_id)
335
rev_tree = self.builder.revision_tree()
336
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
337
# now the work tree is up to date with the branch
339
self.reporter.completed(self.branch.revno(), self.rev_id)
340
if self.config.post_commit() is not None:
341
hooks = self.config.post_commit().split(' ')
342
# this would be nicer with twisted.python.reflect.namedAny
344
result = eval(hook + '(branch, rev_id)',
345
{'branch':self.branch,
347
'rev_id':self.rev_id})
348
self._emit_progress_update()
353
def _any_real_changes(self):
354
"""Are there real changes between new_inventory and basis?
356
For trees without rich roots, inv.root.revision changes every commit.
357
But if that is the only change, we want to treat it as though there
360
new_entries = self.builder.new_inventory.iter_entries()
361
basis_entries = self.basis_inv.iter_entries()
362
new_path, new_root_ie = new_entries.next()
363
basis_path, basis_root_ie = basis_entries.next()
365
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
366
def ie_equal_no_revision(this, other):
367
return ((this.file_id == other.file_id)
368
and (this.name == other.name)
369
and (this.symlink_target == other.symlink_target)
370
and (this.text_sha1 == other.text_sha1)
371
and (this.text_size == other.text_size)
372
and (this.text_id == other.text_id)
373
and (this.parent_id == other.parent_id)
374
and (this.kind == other.kind)
375
and (this.executable == other.executable)
377
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
380
for new_ie, basis_ie in zip(new_entries, basis_entries):
381
if new_ie != basis_ie:
384
# No actual changes present
494
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()
387
520
def _check_pointless(self):
388
521
if self.allow_pointless:
440
568
# so grab the lock
441
569
self.bound_branch = self.branch
442
570
self.master_branch.lock_write()
443
self.master_locked = True
446
"""Cleanup any open locks, progress bars etc."""
447
cleanups = [self._cleanup_bound_branch,
448
self.work_tree.unlock,
450
found_exception = None
451
for cleanup in cleanups:
454
# we want every cleanup to run no matter what.
455
# so we have a catchall here, but we will raise the
456
# last encountered exception up the stack: and
457
# typically this will be useful enough.
460
if found_exception is not None:
461
# don't do a plan raise, because the last exception may have been
462
# trashed, e is our sure-to-work exception even though it loses the
463
# full traceback. XXX: RBC 20060421 perhaps we could check the
464
# exc_info and if its the same one do a plain raise otherwise
465
# 'raise e' as we do now.
468
def _cleanup_bound_branch(self):
469
"""Executed at the end of a try/finally to cleanup a bound branch.
471
If the branch wasn't bound, this is a no-op.
472
If it was, it resents self.branch to the local branch, instead
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
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:
475
626
if not self.bound_branch:
477
if self.master_locked:
478
self.master_branch.unlock()
480
def _escape_commit_message(self):
481
"""Replace xml-incompatible control characters."""
482
# FIXME: RBC 20060419 this should be done by the revision
483
# serialiser not by commit. Then we can also add an unescaper
484
# in the deserializer and start roundtripping revision messages
485
# precisely. See repository_implementations/test_repository.py
487
# Python strings can include characters that can't be
488
# represented in well-formed XML; escape characters that
489
# aren't listed in the XML specification
490
# (http://www.w3.org/TR/REC-xml/#NT-Char).
491
self.message, escape_count = re.subn(
492
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
493
lambda match: match.group(0).encode('unicode_escape'),
496
self.reporter.escaped(escape_count, self.message)
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)
498
664
def _gather_parents(self):
499
665
"""Record the parents of a merge for merge detection."""
500
# TODO: Make sure that this list doesn't contain duplicate
666
# TODO: Make sure that this list doesn't contain duplicate
501
667
# entries and the order is preserved when doing this.
502
self.parents = self.work_tree.get_parent_ids()
503
self.parent_invs = []
504
for revision in self.parents:
668
if self.use_record_iter_changes:
670
self.basis_inv = self.basis_tree.root_inventory
671
self.parent_invs = [self.basis_inv]
672
for revision in self.parents[1:]:
505
673
if self.branch.repository.has_revision(revision):
506
674
mutter('commit parent revision {%s}', revision)
507
675
inventory = self.branch.repository.get_inventory(revision)
510
678
mutter('commit parent ghost revision {%s}', revision)
512
def _remove_deleted(self):
513
"""Remove deleted files from the working inventories.
515
This is done prior to taking the working inventory as the
516
basis for the new committed inventory.
518
This returns true if any files
519
*that existed in the basis inventory* were deleted.
520
Files that were added and deleted
521
in the working copy don't matter.
523
specific = self.specific_files
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()
525
deleted_paths = set()
526
for path, ie in self.work_inv.iter_entries():
527
if is_inside_any(deleted_paths, path):
528
# The tree will delete the required ids recursively.
530
if specific and not is_inside_any(specific, path):
532
if not self.work_tree.has_filename(path):
533
deleted_paths.add(path)
534
self.reporter.missing(path)
535
deleted_ids.append(ie.file_id)
536
self.work_tree.unversion(deleted_ids)
538
def _populate_new_inv(self):
539
"""Build revision inventory.
541
This creates a new empty inventory. Depending on
542
which files are selected for commit, and what is present in the
543
current tree, the new inventory is populated. inventory entries
544
which are candidates for modification have their revision set to
545
None; inventory entries that are carried over untouched have their
546
revision set to their prior value.
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.
548
823
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
549
824
# results to create a new inventory at the same time, which results
550
825
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
551
826
# ADHB 11-07-2006
552
mutter("Selecting files for commit with filter %s", self.specific_files)
553
entries = self.work_inv.iter_entries()
554
if not self.builder.record_root_entry:
555
symbol_versioning.warn('CommitBuilders should support recording'
556
' the root entry as of bzr 0.10.', DeprecationWarning,
558
self.builder.new_inventory.add(self.basis_inv.root.copy())
560
self._emit_progress_update()
561
for path, new_ie in entries:
562
self._emit_progress_update()
563
file_id = new_ie.file_id
564
# mutter('check %s {%s}', path, file_id)
565
if (not self.specific_files or
566
is_inside_or_parent_of_any(self.specific_files, path)):
567
# mutter('%s selected for commit', path)
571
# mutter('%s not selected for commit', path)
572
if self.basis_inv.has_id(file_id):
573
ie = self.basis_inv[file_id].copy()
575
# this entry is new and not being committed
578
self.builder.record_entry_contents(ie, self.parent_invs,
579
path, self.work_tree)
580
# describe the nature of the change that has occurred relative to
581
# the basis inventory.
582
if (self.basis_inv.has_id(ie.file_id)):
583
basis_ie = self.basis_inv[ie.file_id]
586
change = ie.describe_change(basis_ie, ie)
587
if change in (InventoryEntry.RENAMED,
588
InventoryEntry.MODIFIED_AND_RENAMED):
589
old_path = self.basis_inv.id2path(ie.file_id)
590
self.reporter.renamed(change, old_path, path)
592
self.reporter.snapshot_change(change, path)
594
if not self.specific_files:
597
# ignore removals that don't match filespec
598
for path, new_ie in self.basis_inv.iter_entries():
599
if new_ie.file_id in self.work_inv:
601
if is_inside_any(self.specific_files, path):
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()
604
948
ie.revision = None
605
self.builder.record_entry_contents(ie, self.parent_invs, path,
608
def _emit_progress_update(self):
609
"""Emit an update to the progress bar."""
610
self.pb.update("Committing", self.pb_count, self.pb_total)
613
def _report_deletes(self):
614
for path, ie in self.basis_inv.iter_entries():
615
if ie.file_id not in self.builder.new_inventory:
616
self.reporter.deleted(path)
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
added
removed
bzrlib/commit.py
