214
273
if message_callback is None:
215
274
if message is not None:
216
275
if isinstance(message, str):
217
message = message.decode(bzrlib.user_encoding)
276
message = message.decode(get_user_encoding())
218
277
message_callback = lambda x: message
220
279
raise BzrError("The message or message_callback keyword"
221
280
" parameter is required for commit().")
223
282
self.bound_branch = None
283
self.any_entries_deleted = False
284
if exclude is not None:
285
self.exclude = sorted(
286
minimum_path_selection(exclude))
224
289
self.local = local
225
290
self.master_branch = None
226
self.master_locked = False
291
self.recursive = recursive
227
292
self.rev_id = None
228
self.specific_files = specific_files
293
# self.specific_files is None to indicate no filter, or any iterable to
294
# indicate a filter - [] means no files at all, as per iter_changes.
295
if specific_files is not None:
296
self.specific_files = sorted(
297
minimum_path_selection(specific_files))
299
self.specific_files = None
229
301
self.allow_pointless = allow_pointless
230
self.recursive = recursive
231
302
self.revprops = revprops
232
303
self.message_callback = message_callback
233
304
self.timestamp = timestamp
234
305
self.timezone = timezone
235
306
self.committer = committer
236
self.specific_files = specific_files
237
307
self.strict = strict
238
308
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
246
310
self.work_tree.lock_write()
311
operation.add_cleanup(self.work_tree.unlock)
312
self.parents = self.work_tree.get_parent_ids()
313
# We can use record_iter_changes IFF iter_changes is compatible with
314
# the command line parameters, and the repository has fast delta
315
# generation. See bug 347649.
316
self.use_record_iter_changes = (
318
not self.branch.repository._format.supports_tree_reference and
319
(self.branch.repository._format.fast_deltas or
320
len(self.parents) < 2))
247
321
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
322
operation.add_cleanup(self.pb.finished)
323
self.basis_revid = self.work_tree.last_revision()
248
324
self.basis_tree = self.work_tree.basis_tree()
249
325
self.basis_tree.lock_read()
326
operation.add_cleanup(self.basis_tree.unlock)
327
# Cannot commit with conflicts present.
328
if len(self.work_tree.conflicts()) > 0:
329
raise ConflictsInTree
331
# Setup the bound branch variables as needed.
332
self._check_bound_branch(operation, possible_master_transports)
334
# Check that the working tree is up to date
335
old_revno, new_revno = self._check_out_of_date_tree()
337
# Complete configuration setup
338
if reporter is not None:
339
self.reporter = reporter
340
elif self.reporter is None:
341
self.reporter = self._select_reporter()
342
if self.config is None:
343
self.config = self.branch.get_config()
345
self._set_specific_file_ids()
347
# Setup the progress bar. As the number of files that need to be
348
# committed in unknown, progress is reported as stages.
349
# We keep track of entries separately though and include that
350
# information in the progress bar during the relevant stages.
351
self.pb_stage_name = ""
352
self.pb_stage_count = 0
353
self.pb_stage_total = 5
354
if self.bound_branch:
355
self.pb_stage_total += 1
356
self.pb.show_pct = False
357
self.pb.show_spinner = False
358
self.pb.show_eta = False
359
self.pb.show_count = True
360
self.pb.show_bar = True
362
self._gather_parents()
363
# After a merge, a selected file commit is not supported.
364
# See 'bzr help merge' for an explanation as to why.
365
if len(self.parents) > 1 and self.specific_files is not None:
366
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
367
# Excludes are a form of selected file commit.
368
if len(self.parents) > 1 and self.exclude:
369
raise errors.CannotCommitSelectedFileMerge(self.exclude)
371
# Collect the changes
372
self._set_progress_stage("Collecting changes", counter=True)
373
self.builder = self.branch.get_commit_builder(self.parents,
374
self.config, timestamp, timezone, committer, revprops, rev_id)
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
377
self.builder.will_record_deletes()
378
# find the location being committed to
379
if self.bound_branch:
380
master_location = self.master_branch.base
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()
382
master_location = self.branch.base
384
# report the start of the commit
385
self.reporter.started(new_revno, self.rev_id, master_location)
387
self._update_builder_with_changes()
313
388
self._check_pointless()
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.
390
# TODO: Now the new inventory is known, check for conflicts.
318
391
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
319
392
# weave lines, because nothing should be recorded until it is known
320
393
# that commit will succeed.
394
self._set_progress_stage("Saving data locally")
321
395
self.builder.finish_inventory()
322
self._emit_progress_update()
397
# Prompt the user for a commit message if none provided
323
398
message = message_callback(self)
324
assert isinstance(message, unicode), type(message)
325
399
self.message = message
326
self._escape_commit_message()
401
# Add revision data to the local branch
328
402
self.rev_id = self.builder.commit(self.message)
329
self._emit_progress_update()
330
# revision data is in the local branch now.
332
# upload revision data to the master.
333
# this will propagate merged revisions too if needed.
334
if self.bound_branch:
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,
343
# and now do the commit locally.
344
self.branch.set_last_revision_info(new_revno, self.rev_id)
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()
405
mutter("aborting commit write group because of exception:")
406
trace.log_exception_quietly()
407
note("aborting commit write group: %r" % (e,))
411
self._process_pre_hooks(old_revno, new_revno)
413
# Upload revision data to the master.
414
# this will propagate merged revisions too if needed.
415
if self.bound_branch:
416
self._set_progress_stage("Uploading data to master branch")
417
# 'commit' to the master first so a timeout here causes the
418
# local branch to be out of date
419
self.master_branch.import_last_revision_info(
420
self.branch.repository, new_revno, self.rev_id)
422
# and now do the commit locally.
423
self.branch.set_last_revision_info(new_revno, self.rev_id)
425
# Make the working tree be up to date with the branch. This
426
# includes automatic changes scheduled to be made to the tree, such
427
# as updating its basis and unversioning paths that were missing.
428
self.work_tree.unversion(self.deleted_ids)
429
self._set_progress_stage("Updating the working tree")
430
self.work_tree.update_basis_by_delta(self.rev_id,
431
self.builder.get_basis_delta())
432
self.reporter.completed(new_revno, self.rev_id)
433
self._process_post_hooks(old_revno, new_revno)
381
434
return self.rev_id
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
436
def _select_reporter(self):
437
"""Select the CommitReporter to use."""
439
return NullCommitReporter()
440
return ReportCommitToLog()
418
442
def _check_pointless(self):
419
443
if self.allow_pointless:
475
499
# so grab the lock
476
500
self.bound_branch = self.branch
477
501
self.master_branch.lock_write()
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
502
operation.add_cleanup(self.master_branch.unlock)
504
def _check_out_of_date_tree(self):
505
"""Check that the working tree is up to date.
507
:return: old_revision_number,new_revision_number tuple
510
first_tree_parent = self.work_tree.get_parent_ids()[0]
512
# if there are no parents, treat our parent as 'None'
513
# this is so that we still consider the master branch
514
# - in a checkout scenario the tree may have no
515
# parents but the branch may do.
516
first_tree_parent = bzrlib.revision.NULL_REVISION
517
old_revno, master_last = self.master_branch.last_revision_info()
518
if master_last != first_tree_parent:
519
if master_last != bzrlib.revision.NULL_REVISION:
520
raise errors.OutOfDateTree(self.work_tree)
521
if self.branch.repository.has_revision(first_tree_parent):
522
new_revno = old_revno + 1
524
# ghost parents never appear in revision history.
526
return old_revno,new_revno
528
def _process_pre_hooks(self, old_revno, new_revno):
529
"""Process any registered pre commit hooks."""
530
self._set_progress_stage("Running pre_commit hooks")
531
self._process_hooks("pre_commit", old_revno, new_revno)
533
def _process_post_hooks(self, old_revno, new_revno):
534
"""Process any registered post commit hooks."""
535
# Process the post commit hooks, if any
536
self._set_progress_stage("Running post_commit hooks")
537
# old style commit hooks - should be deprecated ? (obsoleted in
539
if self.config.post_commit() is not None:
540
hooks = self.config.post_commit().split(' ')
541
# this would be nicer with twisted.python.reflect.namedAny
543
result = eval(hook + '(branch, rev_id)',
544
{'branch':self.branch,
546
'rev_id':self.rev_id})
547
# process new style post commit hooks
548
self._process_hooks("post_commit", old_revno, new_revno)
550
def _process_hooks(self, hook_name, old_revno, new_revno):
551
if not Branch.hooks[hook_name]:
554
# new style commit hooks:
511
555
if not self.bound_branch:
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)
556
hook_master = self.branch
559
hook_master = self.master_branch
560
hook_local = self.branch
561
# With bound branches, when the master is behind the local branch,
562
# the 'old_revno' and old_revid values here are incorrect.
563
# XXX: FIXME ^. RBC 20060206
565
old_revid = self.parents[0]
567
old_revid = bzrlib.revision.NULL_REVISION
569
if hook_name == "pre_commit":
570
future_tree = self.builder.revision_tree()
571
tree_delta = future_tree.changes_from(self.basis_tree,
574
for hook in Branch.hooks[hook_name]:
575
# show the running hook in the progress bar. As hooks may
576
# end up doing nothing (e.g. because they are not configured by
577
# the user) this is still showing progress, not showing overall
578
# actions - its up to each plugin to show a UI if it want's to
579
# (such as 'Emailing diff to foo@example.com').
580
self.pb_stage_name = "Running %s hooks [%s]" % \
581
(hook_name, Branch.hooks.get_hook_name(hook))
582
self._emit_progress()
583
if 'hooks' in debug.debug_flags:
584
mutter("Invoking commit hook: %r", hook)
585
if hook_name == "post_commit":
586
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
588
elif hook_name == "pre_commit":
589
hook(hook_local, hook_master,
590
old_revno, old_revid, new_revno, self.rev_id,
591
tree_delta, future_tree)
534
593
def _gather_parents(self):
535
594
"""Record the parents of a merge for merge detection."""
536
# TODO: Make sure that this list doesn't contain duplicate
595
# TODO: Make sure that this list doesn't contain duplicate
537
596
# entries and the order is preserved when doing this.
538
self.parents = self.work_tree.get_parent_ids()
597
if self.use_record_iter_changes:
599
self.basis_inv = self.basis_tree.inventory
539
600
self.parent_invs = [self.basis_inv]
540
601
for revision in self.parents[1:]:
541
602
if self.branch.repository.has_revision(revision):
546
607
mutter('commit parent ghost revision {%s}', revision)
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
609
def _update_builder_with_changes(self):
610
"""Update the commit builder with the data about what has changed.
612
exclude = self.exclude
613
specific_files = self.specific_files
614
mutter("Selecting files for commit with filter %s", specific_files)
617
if self.use_record_iter_changes:
618
iter_changes = self.work_tree.iter_changes(self.basis_tree,
619
specific_files=specific_files)
620
iter_changes = self._filter_iter_changes(iter_changes)
621
for file_id, path, fs_hash in self.builder.record_iter_changes(
622
self.work_tree, self.basis_revid, iter_changes):
623
self.work_tree._observed_sha1(file_id, path, fs_hash)
625
# Build the new inventory
626
self._populate_from_inventory()
627
self._record_unselected()
628
self._report_and_accumulate_deletes()
630
def _filter_iter_changes(self, iter_changes):
631
"""Process iter_changes.
633
This method reports on the changes in iter_changes to the user, and
634
converts 'missing' entries in the iter_changes iterator to 'deleted'
635
entries. 'missing' entries have their
637
:param iter_changes: An iter_changes to process.
638
:return: A generator of changes.
640
reporter = self.reporter
641
report_changes = reporter.is_verbose()
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.
643
for change in iter_changes:
645
old_path = change[1][0]
646
new_path = change[1][1]
647
versioned = change[3][1]
649
versioned = change[3][1]
650
if kind is None and versioned:
653
reporter.missing(new_path)
654
deleted_ids.append(change[0])
655
# Reset the new path (None) and new versioned flag (False)
656
change = (change[0], (change[1][0], None), change[2],
657
(change[3][0], False)) + change[4:]
658
elif kind == 'tree-reference':
659
if self.recursive == 'down':
660
self._commit_nested_tree(change[0], change[1][1])
661
if change[3][0] or change[3][1]:
665
reporter.deleted(old_path)
666
elif old_path is None:
667
reporter.snapshot_change('added', new_path)
668
elif old_path != new_path:
669
reporter.renamed('renamed', old_path, new_path)
672
self.work_tree.branch.repository._format.rich_root_data):
673
# Don't report on changes to '' in non rich root
675
reporter.snapshot_change('modified', new_path)
676
self._next_progress_entry()
677
# Unversion IDs that were found to be deleted
678
self.deleted_ids = deleted_ids
680
def _record_unselected(self):
681
# If specific files are selected, then all un-selected files must be
682
# recorded in their previous state. For more details, see
683
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
684
if self.specific_files or self.exclude:
685
specific_files = self.specific_files or []
686
for path, old_ie in self.basis_inv.iter_entries():
687
if old_ie.file_id in self.builder.new_inventory:
688
# already added - skip.
690
if (is_inside_any(specific_files, path)
691
and not is_inside_any(self.exclude, path)):
692
# was inside the selected path, and not excluded - if not
693
# present it has been deleted so skip.
695
# From here down it was either not selected, or was excluded:
696
# We preserve the entry unaltered.
698
# Note: specific file commits after a merge are currently
699
# prohibited. This test is for sanity/safety in case it's
700
# required after that changes.
701
if len(self.parents) > 1:
703
self.builder.record_entry_contents(ie, self.parent_invs, path,
704
self.basis_tree, None)
706
def _report_and_accumulate_deletes(self):
707
if (isinstance(self.basis_inv, Inventory)
708
and isinstance(self.builder.new_inventory, Inventory)):
709
# the older Inventory classes provide a _byid dict, and building a
710
# set from the keys of this dict is substantially faster than even
711
# getting a set of ids from the inventory
713
# <lifeless> set(dict) is roughly the same speed as
714
# set(iter(dict)) and both are significantly slower than
716
deleted_ids = set(self.basis_inv._byid.keys()) - \
717
set(self.builder.new_inventory._byid.keys())
719
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
721
self.any_entries_deleted = True
722
deleted = [(self.basis_tree.id2path(file_id), file_id)
723
for file_id in deleted_ids]
725
# XXX: this is not quite directory-order sorting
726
for path, file_id in deleted:
727
self.builder.record_delete(path, file_id)
728
self.reporter.deleted(path)
730
def _check_strict(self):
731
# XXX: when we use iter_changes this would likely be faster if
732
# iter_changes would check for us (even in the presence of
735
# raise an exception as soon as we find a single unknown.
736
for unknown in self.work_tree.unknowns():
737
raise StrictCommitFailed()
739
def _populate_from_inventory(self):
740
"""Populate the CommitBuilder by walking the working tree inventory."""
741
# Build the revision inventory.
743
# This starts by creating a new empty inventory. Depending on
744
# which files are selected for commit, and what is present in the
745
# current tree, the new inventory is populated. inventory entries
746
# which are candidates for modification have their revision set to
747
# None; inventory entries that are carried over untouched have their
748
# revision set to their prior value.
584
750
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
585
751
# results to create a new inventory at the same time, which results
586
752
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
587
753
# ADHB 11-07-2006
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):
755
specific_files = self.specific_files
756
exclude = self.exclude
757
report_changes = self.reporter.is_verbose()
759
# A tree of paths that have been deleted. E.g. if foo/bar has been
760
# deleted, then we have {'foo':{'bar':{}}}
762
# XXX: Note that entries may have the wrong kind because the entry does
763
# not reflect the status on disk.
764
work_inv = self.work_tree.inventory
765
# NB: entries will include entries within the excluded ids/paths
766
# because iter_entries_by_dir has no 'exclude' facility today.
767
entries = work_inv.iter_entries_by_dir(
768
specific_file_ids=self.specific_file_ids, yield_parents=True)
769
for path, existing_ie in entries:
770
file_id = existing_ie.file_id
771
name = existing_ie.name
772
parent_id = existing_ie.parent_id
773
kind = existing_ie.kind
774
# Skip files that have been deleted from the working tree.
775
# The deleted path ids are also recorded so they can be explicitly
778
path_segments = splitpath(path)
779
deleted_dict = deleted_paths
780
for segment in path_segments:
781
deleted_dict = deleted_dict.get(segment, None)
783
# We either took a path not present in the dict
784
# (deleted_dict was None), or we've reached an empty
785
# child dir in the dict, so are now a sub-path.
789
if deleted_dict is not None:
790
# the path has a deleted parent, do not add it.
792
if exclude and is_inside_any(exclude, path):
793
# Skip excluded paths. Excluded paths are processed by
794
# _update_builder_with_changes.
796
content_summary = self.work_tree.path_content_summary(path)
797
kind = content_summary[0]
798
# Note that when a filter of specific files is given, we must only
799
# skip/record deleted files matching that filter.
800
if not specific_files or is_inside_any(specific_files, path):
801
if kind == 'missing':
802
if not deleted_paths:
803
# path won't have been split yet.
804
path_segments = splitpath(path)
805
deleted_dict = deleted_paths
806
for segment in path_segments:
807
deleted_dict = deleted_dict.setdefault(segment, {})
808
self.reporter.missing(path)
809
self._next_progress_entry()
810
deleted_ids.append(file_id)
812
# TODO: have the builder do the nested commit just-in-time IF and
814
if kind == 'tree-reference':
815
# enforce repository nested tree policy.
816
if (not self.work_tree.supports_tree_reference() or
817
# repository does not support it either.
818
not self.branch.repository._format.supports_tree_reference):
820
content_summary = (kind, None, None, None)
821
elif self.recursive == 'down':
822
nested_revision_id = self._commit_nested_tree(
824
content_summary = (kind, None, None, nested_revision_id)
826
nested_revision_id = self.work_tree.get_reference_revision(file_id)
827
content_summary = (kind, None, None, nested_revision_id)
829
# Record an entry for this item
830
# Note: I don't particularly want to have the existing_ie
831
# parameter but the test suite currently (28-Jun-07) breaks
832
# without it thanks to a unicode normalisation issue. :-(
833
definitely_changed = kind != existing_ie.kind
834
self._record_entry(path, file_id, specific_files, kind, name,
835
parent_id, definitely_changed, existing_ie, report_changes,
838
# Unversion IDs that were found to be deleted
839
self.deleted_ids = deleted_ids
841
def _commit_nested_tree(self, file_id, path):
842
"Commit a nested tree."
843
sub_tree = self.work_tree.get_nested_tree(file_id, path)
844
# FIXME: be more comprehensive here:
845
# this works when both trees are in --trees repository,
846
# but when both are bound to a different repository,
847
# it fails; a better way of approaching this is to
848
# finally implement the explicit-caches approach design
849
# a while back - RBC 20070306.
850
if sub_tree.branch.repository.has_same_location(
851
self.work_tree.branch.repository):
852
sub_tree.branch.repository = \
853
self.work_tree.branch.repository
855
return sub_tree.commit(message=None, revprops=self.revprops,
856
recursive=self.recursive,
857
message_callback=self.message_callback,
858
timestamp=self.timestamp, timezone=self.timezone,
859
committer=self.committer,
860
allow_pointless=self.allow_pointless,
861
strict=self.strict, verbose=self.verbose,
862
local=self.local, reporter=self.reporter)
863
except errors.PointlessCommit:
864
return self.work_tree.get_reference_revision(file_id)
866
def _record_entry(self, path, file_id, specific_files, kind, name,
867
parent_id, definitely_changed, existing_ie, report_changes,
869
"Record the new inventory entry for a path if any."
870
# mutter('check %s {%s}', path, file_id)
871
# mutter('%s selected for commit', path)
872
if definitely_changed or existing_ie is None:
873
ie = make_entry(kind, name, parent_id, file_id)
875
ie = existing_ie.copy()
672
876
ie.revision = 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)
877
# For carried over entries we don't care about the fs hash - the repo
878
# isn't generating a sha, so we're not saving computation time.
879
_, _, fs_hash = self.builder.record_entry_contents(
880
ie, self.parent_invs, path, self.work_tree, content_summary)
882
self._report_change(ie, path)
884
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
887
def _report_change(self, ie, path):
888
"""Report a change to the user.
890
The change that has occurred is described relative to the basis
893
if (self.basis_inv.has_id(ie.file_id)):
894
basis_ie = self.basis_inv[ie.file_id]
897
change = ie.describe_change(basis_ie, ie)
898
if change in (InventoryEntry.RENAMED,
899
InventoryEntry.MODIFIED_AND_RENAMED):
900
old_path = self.basis_inv.id2path(ie.file_id)
901
self.reporter.renamed(change, old_path, path)
902
self._next_progress_entry()
904
if change == 'unchanged':
906
self.reporter.snapshot_change(change, path)
907
self._next_progress_entry()
909
def _set_progress_stage(self, name, counter=False):
910
"""Set the progress stage and emit an update to the progress bar."""
911
self.pb_stage_name = name
912
self.pb_stage_count += 1
914
self.pb_entries_count = 0
916
self.pb_entries_count = None
917
self._emit_progress()
919
def _next_progress_entry(self):
920
"""Emit an update to the progress bar and increment the entry count."""
921
self.pb_entries_count += 1
922
self._emit_progress()
924
def _emit_progress(self):
925
if self.pb_entries_count is not None:
926
text = "%s [%d] - Stage" % (self.pb_stage_name,
927
self.pb_entries_count)
929
text = "%s - Stage" % (self.pb_stage_name, )
930
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
932
def _set_specific_file_ids(self):
933
"""populate self.specific_file_ids if we will use it."""
934
if not self.use_record_iter_changes:
935
# If provided, ensure the specified files are versioned
936
if self.specific_files is not None:
937
# Note: This routine is being called because it raises
938
# PathNotVersionedError as a side effect of finding the IDs. We
939
# later use the ids we found as input to the working tree
940
# inventory iterator, so we only consider those ids rather than
941
# examining the whole tree again.
942
# XXX: Dont we have filter_unversioned to do this more
944
self.specific_file_ids = tree.find_ids_across_trees(
945
self.specific_files, [self.basis_tree, self.work_tree])
947
self.specific_file_ids = None
added
removed
bzrlib/commit.py
