174
message_callback=None):
229
message_callback=None,
232
possible_master_transports=None,
175
234
"""Commit working copy as a new revision.
177
branch -- the deprecated branch to commit to. New callers should pass in
180
message -- the commit message (it or message_callback is required)
182
timestamp -- if not None, seconds-since-epoch for a
183
postdated/predated commit.
185
specific_files -- If true, commit only those files.
187
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.
188
246
Useful for test or import commands that need to tightly
189
247
control what revisions are assigned. If you duplicate
190
248
a revision id that exists elsewhere it is your own fault.
191
249
If null (default), a time/random revision id is generated.
193
allow_pointless -- If true (default), commit even if nothing
251
:param allow_pointless: If true (default), commit even if nothing
194
252
has changed and no merges are recorded.
196
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
197
255
contains unknown files.
199
revprops -- Properties for new revision
257
:param revprops: Properties for new revision
200
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 = config or self.config
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):
202
296
mutter('preparing to commit')
204
if deprecated_passed(branch):
205
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
206
"deprecated as of bzr 0.8. Please use working_tree= instead.",
207
DeprecationWarning, stacklevel=2)
209
self.work_tree = self.branch.bzrdir.open_workingtree()
210
elif working_tree is None:
211
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().")
213
301
self.work_tree = working_tree
214
302
self.branch = self.work_tree.branch
303
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
304
if not self.branch.repository.supports_rich_root():
305
raise errors.RootNotRich()
215
306
if message_callback is None:
216
307
if message is not None:
217
308
if isinstance(message, str):
218
message = message.decode(bzrlib.user_encoding)
309
message = message.decode(get_user_encoding())
219
310
message_callback = lambda x: message
221
312
raise BzrError("The message or message_callback keyword"
222
313
" parameter is required for commit().")
224
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))
225
322
self.local = local
226
323
self.master_branch = None
227
self.master_locked = False
324
self.recursive = recursive
228
325
self.rev_id = None
229
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
230
334
self.allow_pointless = allow_pointless
232
if reporter is None and self.reporter is None:
233
self.reporter = NullCommitReporter()
234
elif reporter is not None:
235
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
237
342
self.work_tree.lock_write()
238
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, 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 is None:
375
self.config = self.branch.get_config()
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, timestamp, timezone, committer, self.revprops,
411
if not self.builder.supports_record_entry_contents and self.exclude:
413
raise errors.ExcludesUnsupported(self.branch.repository)
240
# Cannot commit with conflicts present.
241
if len(self.work_tree.conflicts())>0:
242
raise ConflictsInTree
244
# setup the bound branch variables as needed.
245
self._check_bound_branch()
247
# check for out of date working trees
249
first_tree_parent = self.work_tree.get_parent_ids()[0]
251
# if there are no parents, treat our parent as 'None'
252
# this is so that we still consier the master branch
253
# - in a checkout scenario the tree may have no
254
# parents but the branch may do.
255
first_tree_parent = None
256
master_last = self.master_branch.last_revision()
257
if (master_last is not None and
258
master_last != first_tree_parent):
259
raise errors.OutOfDateTree(self.work_tree)
262
# raise an exception as soon as we find a single unknown.
263
for unknown in self.work_tree.unknowns():
264
raise StrictCommitFailed()
266
if self.config is None:
267
self.config = self.branch.get_config()
269
self.work_inv = self.work_tree.inventory
270
self.basis_tree = self.work_tree.basis_tree()
271
self.basis_inv = self.basis_tree.inventory
272
if specific_files is not None:
273
# Ensure specified files are versioned
274
# (We don't actually need the ids here)
275
tree.find_ids_across_trees(specific_files,
276
[self.basis_tree, self.work_tree])
277
# one to finish, one for rev and inventory, and one for each
278
# inventory entry, and the same for the new inventory.
279
# note that this estimate is too long when we do a partial tree
280
# commit which excludes some new files from being considered.
281
# The estimate is corrected when we populate the new inv.
282
self.pb_total = len(self.work_inv) + 5
285
self._gather_parents()
286
if len(self.parents) > 1 and self.specific_files:
287
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
290
self.builder = self.branch.get_commit_builder(self.parents,
291
self.config, timestamp, timezone, committer, revprops, rev_id)
293
self._remove_deleted()
294
self._populate_new_inv()
295
self._report_deletes()
416
self.builder.will_record_deletes()
417
# find the location being committed to
418
if self.bound_branch:
419
master_location = self.master_branch.base
421
master_location = self.branch.base
423
# report the start of the commit
424
self.reporter.started(new_revno, self.rev_id, master_location)
426
self._update_builder_with_changes()
297
427
self._check_pointless()
299
self._emit_progress_update()
300
# TODO: Now the new inventory is known, check for conflicts and
301
# prompt the user for a commit message.
429
# TODO: Now the new inventory is known, check for conflicts.
302
430
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
303
431
# weave lines, because nothing should be recorded until it is known
304
432
# that commit will succeed.
433
self._set_progress_stage("Saving data locally")
305
434
self.builder.finish_inventory()
306
self._emit_progress_update()
436
# Prompt the user for a commit message if none provided
307
437
message = message_callback(self)
308
assert isinstance(message, unicode), type(message)
309
438
self.message = message
310
self._escape_commit_message()
440
# Add revision data to the local branch
312
441
self.rev_id = self.builder.commit(self.message)
313
self._emit_progress_update()
314
# revision data is in the local branch now.
316
# upload revision data to the master.
317
# this will propagate merged revisions too if needed.
318
if self.bound_branch:
319
self.master_branch.repository.fetch(self.branch.repository,
320
revision_id=self.rev_id)
321
# now the master has the revision data
322
# 'commit' to the master first so a timeout here causes the local
323
# branch to be out of date
324
self.master_branch.append_revision(self.rev_id)
326
# and now do the commit locally.
327
self.branch.append_revision(self.rev_id)
329
rev_tree = self.builder.revision_tree()
330
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
331
# now the work tree is up to date with the branch
333
self.reporter.completed(self.branch.revno(), self.rev_id)
334
if self.config.post_commit() is not None:
335
hooks = self.config.post_commit().split(' ')
336
# this would be nicer with twisted.python.reflect.namedAny
338
result = eval(hook + '(branch, rev_id)',
339
{'branch':self.branch,
341
'rev_id':self.rev_id})
342
self._emit_progress_update()
444
mutter("aborting commit write group because of exception:")
445
trace.log_exception_quietly()
446
note("aborting commit write group: %r" % (e,))
450
self._process_pre_hooks(old_revno, new_revno)
452
# Upload revision data to the master.
453
# this will propagate merged revisions too if needed.
454
if self.bound_branch:
455
self._set_progress_stage("Uploading data to master branch")
456
# 'commit' to the master first so a timeout here causes the
457
# local branch to be out of date
458
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
459
self.branch, new_revno, self.rev_id, lossy=lossy)
461
self.branch.fetch(self.master_branch, self.rev_id)
463
# and now do the commit locally.
464
self.branch.set_last_revision_info(new_revno, self.rev_id)
466
# Merge local tags to remote
467
if self.bound_branch:
468
self._set_progress_stage("Merging tags to master branch")
469
tag_conflicts = self.branch.tags.merge_to(self.master_branch.tags)
471
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
472
note("Conflicting tags in bound branch:\n" +
473
"\n".join(warning_lines))
475
# Make the working tree be up to date with the branch. This
476
# includes automatic changes scheduled to be made to the tree, such
477
# as updating its basis and unversioning paths that were missing.
478
self.work_tree.unversion(self.deleted_ids)
479
self._set_progress_stage("Updating the working tree")
480
self.work_tree.update_basis_by_delta(self.rev_id,
481
self.builder.get_basis_delta())
482
self.reporter.completed(new_revno, self.rev_id)
483
self._process_post_hooks(old_revno, new_revno)
345
484
return self.rev_id
347
def _any_real_changes(self):
348
"""Are there real changes between new_inventory and basis?
350
For trees without rich roots, inv.root.revision changes every commit.
351
But if that is the only change, we want to treat it as though there
354
new_entries = self.builder.new_inventory.iter_entries()
355
basis_entries = self.basis_inv.iter_entries()
356
new_path, new_root_ie = new_entries.next()
357
basis_path, basis_root_ie = basis_entries.next()
359
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
360
def ie_equal_no_revision(this, other):
361
return ((this.file_id == other.file_id)
362
and (this.name == other.name)
363
and (this.symlink_target == other.symlink_target)
364
and (this.text_sha1 == other.text_sha1)
365
and (this.text_size == other.text_size)
366
and (this.text_id == other.text_id)
367
and (this.parent_id == other.parent_id)
368
and (this.kind == other.kind)
369
and (this.executable == other.executable)
371
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
374
for new_ie, basis_ie in zip(new_entries, basis_entries):
375
if new_ie != basis_ie:
378
# No actual changes present
486
def _select_reporter(self):
487
"""Select the CommitReporter to use."""
489
return NullCommitReporter()
490
return ReportCommitToLog()
381
492
def _check_pointless(self):
382
493
if self.allow_pointless:
438
549
# so grab the lock
439
550
self.bound_branch = self.branch
440
551
self.master_branch.lock_write()
441
self.master_locked = True
444
"""Cleanup any open locks, progress bars etc."""
445
cleanups = [self._cleanup_bound_branch,
446
self.work_tree.unlock,
448
found_exception = None
449
for cleanup in cleanups:
452
# we want every cleanup to run no matter what.
453
# so we have a catchall here, but we will raise the
454
# last encountered exception up the stack: and
455
# typically this will be useful enough.
458
if found_exception is not None:
459
# don't do a plan raise, because the last exception may have been
460
# trashed, e is our sure-to-work exception even though it loses the
461
# full traceback. XXX: RBC 20060421 perhaps we could check the
462
# exc_info and if its the same one do a plain raise otherwise
463
# 'raise e' as we do now.
466
def _cleanup_bound_branch(self):
467
"""Executed at the end of a try/finally to cleanup a bound branch.
469
If the branch wasn't bound, this is a no-op.
470
If it was, it resents self.branch to the local branch, instead
552
operation.add_cleanup(self.master_branch.unlock)
554
def _check_out_of_date_tree(self):
555
"""Check that the working tree is up to date.
557
:return: old_revision_number,new_revision_number tuple
560
first_tree_parent = self.work_tree.get_parent_ids()[0]
562
# if there are no parents, treat our parent as 'None'
563
# this is so that we still consider the master branch
564
# - in a checkout scenario the tree may have no
565
# parents but the branch may do.
566
first_tree_parent = bzrlib.revision.NULL_REVISION
567
old_revno, master_last = self.master_branch.last_revision_info()
568
if master_last != first_tree_parent:
569
if master_last != bzrlib.revision.NULL_REVISION:
570
raise errors.OutOfDateTree(self.work_tree)
571
if self.branch.repository.has_revision(first_tree_parent):
572
new_revno = old_revno + 1
574
# ghost parents never appear in revision history.
576
return old_revno,new_revno
578
def _process_pre_hooks(self, old_revno, new_revno):
579
"""Process any registered pre commit hooks."""
580
self._set_progress_stage("Running pre_commit hooks")
581
self._process_hooks("pre_commit", old_revno, new_revno)
583
def _process_post_hooks(self, old_revno, new_revno):
584
"""Process any registered post commit hooks."""
585
# Process the post commit hooks, if any
586
self._set_progress_stage("Running post_commit hooks")
587
# old style commit hooks - should be deprecated ? (obsoleted in
589
if self.config.post_commit() is not None:
590
hooks = self.config.post_commit().split(' ')
591
# this would be nicer with twisted.python.reflect.namedAny
593
result = eval(hook + '(branch, rev_id)',
594
{'branch':self.branch,
596
'rev_id':self.rev_id})
597
# process new style post commit hooks
598
self._process_hooks("post_commit", old_revno, new_revno)
600
def _process_hooks(self, hook_name, old_revno, new_revno):
601
if not Branch.hooks[hook_name]:
604
# new style commit hooks:
473
605
if not self.bound_branch:
475
if self.master_locked:
476
self.master_branch.unlock()
478
def _escape_commit_message(self):
479
"""Replace xml-incompatible control characters."""
480
# FIXME: RBC 20060419 this should be done by the revision
481
# serialiser not by commit. Then we can also add an unescaper
482
# in the deserializer and start roundtripping revision messages
483
# precisely. See repository_implementations/test_repository.py
485
# Python strings can include characters that can't be
486
# represented in well-formed XML; escape characters that
487
# aren't listed in the XML specification
488
# (http://www.w3.org/TR/REC-xml/#NT-Char).
489
self.message, escape_count = re.subn(
490
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
491
lambda match: match.group(0).encode('unicode_escape'),
494
self.reporter.escaped(escape_count, self.message)
606
hook_master = self.branch
609
hook_master = self.master_branch
610
hook_local = self.branch
611
# With bound branches, when the master is behind the local branch,
612
# the 'old_revno' and old_revid values here are incorrect.
613
# XXX: FIXME ^. RBC 20060206
615
old_revid = self.parents[0]
617
old_revid = bzrlib.revision.NULL_REVISION
619
if hook_name == "pre_commit":
620
future_tree = self.builder.revision_tree()
621
tree_delta = future_tree.changes_from(self.basis_tree,
624
for hook in Branch.hooks[hook_name]:
625
# show the running hook in the progress bar. As hooks may
626
# end up doing nothing (e.g. because they are not configured by
627
# the user) this is still showing progress, not showing overall
628
# actions - its up to each plugin to show a UI if it want's to
629
# (such as 'Emailing diff to foo@example.com').
630
self.pb_stage_name = "Running %s hooks [%s]" % \
631
(hook_name, Branch.hooks.get_hook_name(hook))
632
self._emit_progress()
633
if 'hooks' in debug.debug_flags:
634
mutter("Invoking commit hook: %r", hook)
635
if hook_name == "post_commit":
636
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
638
elif hook_name == "pre_commit":
639
hook(hook_local, hook_master,
640
old_revno, old_revid, new_revno, self.rev_id,
641
tree_delta, future_tree)
496
643
def _gather_parents(self):
497
644
"""Record the parents of a merge for merge detection."""
498
# TODO: Make sure that this list doesn't contain duplicate
645
# TODO: Make sure that this list doesn't contain duplicate
499
646
# entries and the order is preserved when doing this.
500
self.parents = self.work_tree.get_parent_ids()
501
self.parent_invs = []
502
for revision in self.parents:
647
if self.use_record_iter_changes:
649
self.basis_inv = self.basis_tree.inventory
650
self.parent_invs = [self.basis_inv]
651
for revision in self.parents[1:]:
503
652
if self.branch.repository.has_revision(revision):
504
653
mutter('commit parent revision {%s}', revision)
505
654
inventory = self.branch.repository.get_inventory(revision)
508
657
mutter('commit parent ghost revision {%s}', revision)
510
def _remove_deleted(self):
511
"""Remove deleted files from the working inventories.
513
This is done prior to taking the working inventory as the
514
basis for the new committed inventory.
516
This returns true if any files
517
*that existed in the basis inventory* were deleted.
518
Files that were added and deleted
519
in the working copy don't matter.
521
specific = self.specific_files
659
def _update_builder_with_changes(self):
660
"""Update the commit builder with the data about what has changed.
662
exclude = self.exclude
663
specific_files = self.specific_files
664
mutter("Selecting files for commit with filter %s", specific_files)
667
if self.use_record_iter_changes:
668
iter_changes = self.work_tree.iter_changes(self.basis_tree,
669
specific_files=specific_files)
670
iter_changes = self._filter_iter_changes(iter_changes)
671
for file_id, path, fs_hash in self.builder.record_iter_changes(
672
self.work_tree, self.basis_revid, iter_changes):
673
self.work_tree._observed_sha1(file_id, path, fs_hash)
675
# Build the new inventory
676
self._populate_from_inventory()
677
self._record_unselected()
678
self._report_and_accumulate_deletes()
680
def _filter_iter_changes(self, iter_changes):
681
"""Process iter_changes.
683
This method reports on the changes in iter_changes to the user, and
684
converts 'missing' entries in the iter_changes iterator to 'deleted'
685
entries. 'missing' entries have their
687
:param iter_changes: An iter_changes to process.
688
:return: A generator of changes.
690
reporter = self.reporter
691
report_changes = reporter.is_verbose()
523
deleted_paths = set()
524
for path, ie in self.work_inv.iter_entries():
525
if is_inside_any(deleted_paths, path):
526
# The tree will delete the required ids recursively.
528
if specific and not is_inside_any(specific, path):
530
if not self.work_tree.has_filename(path):
531
deleted_paths.add(path)
532
self.reporter.missing(path)
533
deleted_ids.append(ie.file_id)
534
self.work_tree.unversion(deleted_ids)
536
def _populate_new_inv(self):
537
"""Build revision inventory.
539
This creates a new empty inventory. Depending on
540
which files are selected for commit, and what is present in the
541
current tree, the new inventory is populated. inventory entries
542
which are candidates for modification have their revision set to
543
None; inventory entries that are carried over untouched have their
544
revision set to their prior value.
693
for change in iter_changes:
695
old_path = change[1][0]
696
new_path = change[1][1]
697
versioned = change[3][1]
699
versioned = change[3][1]
700
if kind is None and versioned:
703
reporter.missing(new_path)
704
deleted_ids.append(change[0])
705
# Reset the new path (None) and new versioned flag (False)
706
change = (change[0], (change[1][0], None), change[2],
707
(change[3][0], False)) + change[4:]
708
elif kind == 'tree-reference':
709
if self.recursive == 'down':
710
self._commit_nested_tree(change[0], change[1][1])
711
if change[3][0] or change[3][1]:
715
reporter.deleted(old_path)
716
elif old_path is None:
717
reporter.snapshot_change('added', new_path)
718
elif old_path != new_path:
719
reporter.renamed('renamed', old_path, new_path)
722
self.work_tree.branch.repository._format.rich_root_data):
723
# Don't report on changes to '' in non rich root
725
reporter.snapshot_change('modified', new_path)
726
self._next_progress_entry()
727
# Unversion IDs that were found to be deleted
728
self.deleted_ids = deleted_ids
730
def _record_unselected(self):
731
# If specific files are selected, then all un-selected files must be
732
# recorded in their previous state. For more details, see
733
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
734
if self.specific_files or self.exclude:
735
specific_files = self.specific_files or []
736
for path, old_ie in self.basis_inv.iter_entries():
737
if old_ie.file_id in self.builder.new_inventory:
738
# already added - skip.
740
if (is_inside_any(specific_files, path)
741
and not is_inside_any(self.exclude, path)):
742
# was inside the selected path, and not excluded - if not
743
# present it has been deleted so skip.
745
# From here down it was either not selected, or was excluded:
746
# We preserve the entry unaltered.
748
# Note: specific file commits after a merge are currently
749
# prohibited. This test is for sanity/safety in case it's
750
# required after that changes.
751
if len(self.parents) > 1:
753
self.builder.record_entry_contents(ie, self.parent_invs, path,
754
self.basis_tree, None)
756
def _report_and_accumulate_deletes(self):
757
if (isinstance(self.basis_inv, Inventory)
758
and isinstance(self.builder.new_inventory, Inventory)):
759
# the older Inventory classes provide a _byid dict, and building a
760
# set from the keys of this dict is substantially faster than even
761
# getting a set of ids from the inventory
763
# <lifeless> set(dict) is roughly the same speed as
764
# set(iter(dict)) and both are significantly slower than
766
deleted_ids = set(self.basis_inv._byid.keys()) - \
767
set(self.builder.new_inventory._byid.keys())
769
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
771
self.any_entries_deleted = True
772
deleted = [(self.basis_tree.id2path(file_id), file_id)
773
for file_id in deleted_ids]
775
# XXX: this is not quite directory-order sorting
776
for path, file_id in deleted:
777
self.builder.record_delete(path, file_id)
778
self.reporter.deleted(path)
780
def _check_strict(self):
781
# XXX: when we use iter_changes this would likely be faster if
782
# iter_changes would check for us (even in the presence of
785
# raise an exception as soon as we find a single unknown.
786
for unknown in self.work_tree.unknowns():
787
raise StrictCommitFailed()
789
def _populate_from_inventory(self):
790
"""Populate the CommitBuilder by walking the working tree inventory."""
791
# Build the revision inventory.
793
# This starts by creating a new empty inventory. Depending on
794
# which files are selected for commit, and what is present in the
795
# current tree, the new inventory is populated. inventory entries
796
# which are candidates for modification have their revision set to
797
# None; inventory entries that are carried over untouched have their
798
# revision set to their prior value.
546
800
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
547
801
# results to create a new inventory at the same time, which results
548
802
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
549
803
# ADHB 11-07-2006
550
mutter("Selecting files for commit with filter %s", self.specific_files)
551
assert self.work_inv.root is not None
552
entries = self.work_inv.iter_entries()
553
if not self.builder.record_root_entry:
554
symbol_versioning.warn('CommitBuilders should support recording'
555
' the root entry as of bzr 0.10.', DeprecationWarning,
557
self.builder.new_inventory.add(self.basis_inv.root.copy())
559
self._emit_progress_update()
560
for path, new_ie in entries:
561
self._emit_progress_update()
562
file_id = new_ie.file_id
563
# mutter('check %s {%s}', path, file_id)
564
if (not self.specific_files or
565
is_inside_or_parent_of_any(self.specific_files, path)):
566
# mutter('%s selected for commit', path)
570
# mutter('%s not selected for commit', path)
571
if self.basis_inv.has_id(file_id):
572
ie = self.basis_inv[file_id].copy()
574
# this entry is new and not being committed
576
self.builder.record_entry_contents(ie, self.parent_invs,
577
path, self.work_tree)
578
# describe the nature of the change that has occurred relative to
579
# the basis inventory.
580
if (self.basis_inv.has_id(ie.file_id)):
581
basis_ie = self.basis_inv[ie.file_id]
584
change = ie.describe_change(basis_ie, ie)
585
if change in (InventoryEntry.RENAMED,
586
InventoryEntry.MODIFIED_AND_RENAMED):
587
old_path = self.basis_inv.id2path(ie.file_id)
588
self.reporter.renamed(change, old_path, path)
590
self.reporter.snapshot_change(change, path)
592
if not self.specific_files:
595
# ignore removals that don't match filespec
596
for path, new_ie in self.basis_inv.iter_entries():
597
if new_ie.file_id in self.work_inv:
599
if is_inside_any(self.specific_files, path):
805
specific_files = self.specific_files
806
exclude = self.exclude
807
report_changes = self.reporter.is_verbose()
809
# A tree of paths that have been deleted. E.g. if foo/bar has been
810
# deleted, then we have {'foo':{'bar':{}}}
812
# XXX: Note that entries may have the wrong kind because the entry does
813
# not reflect the status on disk.
814
work_inv = self.work_tree.inventory
815
# NB: entries will include entries within the excluded ids/paths
816
# because iter_entries_by_dir has no 'exclude' facility today.
817
entries = work_inv.iter_entries_by_dir(
818
specific_file_ids=self.specific_file_ids, yield_parents=True)
819
for path, existing_ie in entries:
820
file_id = existing_ie.file_id
821
name = existing_ie.name
822
parent_id = existing_ie.parent_id
823
kind = existing_ie.kind
824
# Skip files that have been deleted from the working tree.
825
# The deleted path ids are also recorded so they can be explicitly
828
path_segments = splitpath(path)
829
deleted_dict = deleted_paths
830
for segment in path_segments:
831
deleted_dict = deleted_dict.get(segment, None)
833
# We either took a path not present in the dict
834
# (deleted_dict was None), or we've reached an empty
835
# child dir in the dict, so are now a sub-path.
839
if deleted_dict is not None:
840
# the path has a deleted parent, do not add it.
842
if exclude and is_inside_any(exclude, path):
843
# Skip excluded paths. Excluded paths are processed by
844
# _update_builder_with_changes.
846
content_summary = self.work_tree.path_content_summary(path)
847
kind = content_summary[0]
848
# Note that when a filter of specific files is given, we must only
849
# skip/record deleted files matching that filter.
850
if not specific_files or is_inside_any(specific_files, path):
851
if kind == 'missing':
852
if not deleted_paths:
853
# path won't have been split yet.
854
path_segments = splitpath(path)
855
deleted_dict = deleted_paths
856
for segment in path_segments:
857
deleted_dict = deleted_dict.setdefault(segment, {})
858
self.reporter.missing(path)
859
self._next_progress_entry()
860
deleted_ids.append(file_id)
862
# TODO: have the builder do the nested commit just-in-time IF and
864
if kind == 'tree-reference':
865
# enforce repository nested tree policy.
866
if (not self.work_tree.supports_tree_reference() or
867
# repository does not support it either.
868
not self.branch.repository._format.supports_tree_reference):
870
content_summary = (kind, None, None, None)
871
elif self.recursive == 'down':
872
nested_revision_id = self._commit_nested_tree(
874
content_summary = (kind, None, None, nested_revision_id)
876
nested_revision_id = self.work_tree.get_reference_revision(file_id)
877
content_summary = (kind, None, None, nested_revision_id)
879
# Record an entry for this item
880
# Note: I don't particularly want to have the existing_ie
881
# parameter but the test suite currently (28-Jun-07) breaks
882
# without it thanks to a unicode normalisation issue. :-(
883
definitely_changed = kind != existing_ie.kind
884
self._record_entry(path, file_id, specific_files, kind, name,
885
parent_id, definitely_changed, existing_ie, report_changes,
888
# Unversion IDs that were found to be deleted
889
self.deleted_ids = deleted_ids
891
def _commit_nested_tree(self, file_id, path):
892
"Commit a nested tree."
893
sub_tree = self.work_tree.get_nested_tree(file_id, path)
894
# FIXME: be more comprehensive here:
895
# this works when both trees are in --trees repository,
896
# but when both are bound to a different repository,
897
# it fails; a better way of approaching this is to
898
# finally implement the explicit-caches approach design
899
# a while back - RBC 20070306.
900
if sub_tree.branch.repository.has_same_location(
901
self.work_tree.branch.repository):
902
sub_tree.branch.repository = \
903
self.work_tree.branch.repository
905
return sub_tree.commit(message=None, revprops=self.revprops,
906
recursive=self.recursive,
907
message_callback=self.message_callback,
908
timestamp=self.timestamp, timezone=self.timezone,
909
committer=self.committer,
910
allow_pointless=self.allow_pointless,
911
strict=self.strict, verbose=self.verbose,
912
local=self.local, reporter=self.reporter)
913
except errors.PointlessCommit:
914
return self.work_tree.get_reference_revision(file_id)
916
def _record_entry(self, path, file_id, specific_files, kind, name,
917
parent_id, definitely_changed, existing_ie, report_changes,
919
"Record the new inventory entry for a path if any."
920
# mutter('check %s {%s}', path, file_id)
921
# mutter('%s selected for commit', path)
922
if definitely_changed or existing_ie is None:
923
ie = make_entry(kind, name, parent_id, file_id)
925
ie = existing_ie.copy()
602
926
ie.revision = None
603
self.builder.record_entry_contents(ie, self.parent_invs, path,
606
def _emit_progress_update(self):
607
"""Emit an update to the progress bar."""
608
self.pb.update("Committing", self.pb_count, self.pb_total)
611
def _report_deletes(self):
612
for path, ie in self.basis_inv.iter_entries():
613
if ie.file_id not in self.builder.new_inventory:
614
self.reporter.deleted(path)
927
# For carried over entries we don't care about the fs hash - the repo
928
# isn't generating a sha, so we're not saving computation time.
929
_, _, fs_hash = self.builder.record_entry_contents(
930
ie, self.parent_invs, path, self.work_tree, content_summary)
932
self._report_change(ie, path)
934
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
937
def _report_change(self, ie, path):
938
"""Report a change to the user.
940
The change that has occurred is described relative to the basis
943
if (self.basis_inv.has_id(ie.file_id)):
944
basis_ie = self.basis_inv[ie.file_id]
947
change = ie.describe_change(basis_ie, ie)
948
if change in (InventoryEntry.RENAMED,
949
InventoryEntry.MODIFIED_AND_RENAMED):
950
old_path = self.basis_inv.id2path(ie.file_id)
951
self.reporter.renamed(change, old_path, path)
952
self._next_progress_entry()
954
if change == 'unchanged':
956
self.reporter.snapshot_change(change, path)
957
self._next_progress_entry()
959
def _set_progress_stage(self, name, counter=False):
960
"""Set the progress stage and emit an update to the progress bar."""
961
self.pb_stage_name = name
962
self.pb_stage_count += 1
964
self.pb_entries_count = 0
966
self.pb_entries_count = None
967
self._emit_progress()
969
def _next_progress_entry(self):
970
"""Emit an update to the progress bar and increment the entry count."""
971
self.pb_entries_count += 1
972
self._emit_progress()
974
def _emit_progress(self):
975
if self.pb_entries_count is not None:
976
text = "%s [%d] - Stage" % (self.pb_stage_name,
977
self.pb_entries_count)
979
text = "%s - Stage" % (self.pb_stage_name, )
980
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
982
def _set_specific_file_ids(self):
983
"""populate self.specific_file_ids if we will use it."""
984
if not self.use_record_iter_changes:
985
# If provided, ensure the specified files are versioned
986
if self.specific_files is not None:
987
# Note: This routine is being called because it raises
988
# PathNotVersionedError as a side effect of finding the IDs. We
989
# later use the ids we found as input to the working tree
990
# inventory iterator, so we only consider those ids rather than
991
# examining the whole tree again.
992
# XXX: Dont we have filter_unversioned to do this more
994
self.specific_file_ids = tree.find_ids_across_trees(
995
self.specific_files, [self.basis_tree, self.work_tree])
997
self.specific_file_ids = None
added
removed
bzrlib/commit.py
