207
message_callback=None,
210
possible_master_transports=None):
174
message_callback=None):
211
175
"""Commit working copy as a new revision.
213
:param message: the commit message (it or message_callback is required)
214
:param message_callback: A callback: message = message_callback(cmt_obj)
216
:param timestamp: if not None, seconds-since-epoch for a
217
postdated/predated commit.
219
:param specific_files: If not None, commit only those files. An empty
220
list means 'commit no files'.
222
:param rev_id: If set, use this as the new revision id.
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.
223
188
Useful for test or import commands that need to tightly
224
189
control what revisions are assigned. If you duplicate
225
190
a revision id that exists elsewhere it is your own fault.
226
191
If null (default), a time/random revision id is generated.
228
:param allow_pointless: If true (default), commit even if nothing
193
allow_pointless -- If true (default), commit even if nothing
229
194
has changed and no merges are recorded.
231
:param strict: If true, don't allow a commit if the working tree
196
strict -- If true, don't allow a commit if the working tree
232
197
contains unknown files.
234
:param revprops: Properties for new revision
199
revprops -- Properties for new revision
235
200
:param local: Perform a local only commit.
236
:param reporter: the reporter to use or None for the default
237
:param verbose: if True and the reporter is not None, report everything
238
:param recursive: If set to 'down', commit in any subtrees that have
239
pending changes of any sort during this commit.
240
:param exclude: None or a list of relative paths to exclude from the
241
commit. Pending changes to excluded files will be ignored by the
244
operation = OperationWithCleanups(self._commit)
245
self.revprops = revprops or {}
246
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
247
self.config = config or self.config
248
return operation.run(
253
specific_files=specific_files,
255
allow_pointless=allow_pointless,
258
working_tree=working_tree,
261
message_callback=message_callback,
264
possible_master_transports=possible_master_transports)
266
def _commit(self, operation, message, timestamp, timezone, committer,
267
specific_files, rev_id, allow_pointless, strict, verbose,
268
working_tree, local, reporter, message_callback, recursive,
269
exclude, possible_master_transports):
270
202
mutter('preparing to commit')
272
if working_tree is None:
273
raise BzrError("working_tree must be passed into 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().")
275
213
self.work_tree = working_tree
276
214
self.branch = self.work_tree.branch
277
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
278
if not self.branch.repository.supports_rich_root():
279
raise errors.RootNotRich()
280
215
if message_callback is None:
281
216
if message is not None:
282
217
if isinstance(message, str):
283
message = message.decode(get_user_encoding())
218
message = message.decode(bzrlib.user_encoding)
284
219
message_callback = lambda x: message
286
221
raise BzrError("The message or message_callback keyword"
287
222
" parameter is required for commit().")
289
224
self.bound_branch = None
290
self.any_entries_deleted = False
291
if exclude is not None:
292
self.exclude = sorted(
293
minimum_path_selection(exclude))
296
225
self.local = local
297
226
self.master_branch = None
298
self.recursive = recursive
227
self.master_locked = False
299
228
self.rev_id = None
300
# self.specific_files is None to indicate no filter, or any iterable to
301
# indicate a filter - [] means no files at all, as per iter_changes.
302
if specific_files is not None:
303
self.specific_files = sorted(
304
minimum_path_selection(specific_files))
306
self.specific_files = None
229
self.specific_files = specific_files
308
230
self.allow_pointless = allow_pointless
309
self.message_callback = message_callback
310
self.timestamp = timestamp
311
self.timezone = timezone
312
self.committer = committer
314
self.verbose = verbose
232
if reporter is None and self.reporter is None:
233
self.reporter = NullCommitReporter()
234
elif reporter is not None:
235
self.reporter = reporter
316
237
self.work_tree.lock_write()
317
operation.add_cleanup(self.work_tree.unlock)
318
self.parents = self.work_tree.get_parent_ids()
319
# We can use record_iter_changes IFF iter_changes is compatible with
320
# the command line parameters, and the repository has fast delta
321
# generation. See bug 347649.
322
self.use_record_iter_changes = (
324
not self.branch.repository._format.supports_tree_reference and
325
(self.branch.repository._format.fast_deltas or
326
len(self.parents) < 2))
327
238
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
328
operation.add_cleanup(self.pb.finished)
329
self.basis_revid = self.work_tree.last_revision()
330
self.basis_tree = self.work_tree.basis_tree()
331
self.basis_tree.lock_read()
332
operation.add_cleanup(self.basis_tree.unlock)
333
# Cannot commit with conflicts present.
334
if len(self.work_tree.conflicts()) > 0:
335
raise ConflictsInTree
337
# Setup the bound branch variables as needed.
338
self._check_bound_branch(operation, possible_master_transports)
340
# Check that the working tree is up to date
341
old_revno, new_revno = self._check_out_of_date_tree()
343
# Complete configuration setup
344
if reporter is not None:
345
self.reporter = reporter
346
elif self.reporter is None:
347
self.reporter = self._select_reporter()
348
if self.config is None:
349
self.config = self.branch.get_config()
351
self._set_specific_file_ids()
353
# Setup the progress bar. As the number of files that need to be
354
# committed in unknown, progress is reported as stages.
355
# We keep track of entries separately though and include that
356
# information in the progress bar during the relevant stages.
357
self.pb_stage_name = ""
358
self.pb_stage_count = 0
359
self.pb_stage_total = 5
360
if self.bound_branch:
361
self.pb_stage_total += 1
362
self.pb.show_pct = False
363
self.pb.show_spinner = False
364
self.pb.show_eta = False
365
self.pb.show_count = True
366
self.pb.show_bar = True
368
self._gather_parents()
369
# After a merge, a selected file commit is not supported.
370
# See 'bzr help merge' for an explanation as to why.
371
if len(self.parents) > 1 and self.specific_files is not None:
372
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
373
# Excludes are a form of selected file commit.
374
if len(self.parents) > 1 and self.exclude:
375
raise errors.CannotCommitSelectedFileMerge(self.exclude)
377
# Collect the changes
378
self._set_progress_stage("Collecting changes", counter=True)
379
self.builder = self.branch.get_commit_builder(self.parents,
380
self.config, timestamp, timezone, committer, self.revprops, rev_id)
383
self.builder.will_record_deletes()
384
# find the location being committed to
385
if self.bound_branch:
386
master_location = self.master_branch.base
388
master_location = self.branch.base
390
# report the start of the commit
391
self.reporter.started(new_revno, self.rev_id, master_location)
393
self._update_builder_with_changes()
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()
394
297
self._check_pointless()
396
# TODO: Now the new inventory is known, check for conflicts.
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.
397
302
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
398
303
# weave lines, because nothing should be recorded until it is known
399
304
# that commit will succeed.
400
self._set_progress_stage("Saving data locally")
401
305
self.builder.finish_inventory()
403
# Prompt the user for a commit message if none provided
306
self._emit_progress_update()
404
307
message = message_callback(self)
308
assert isinstance(message, unicode), type(message)
405
309
self.message = message
310
self._escape_commit_message()
407
# Add revision data to the local branch
408
312
self.rev_id = self.builder.commit(self.message)
411
mutter("aborting commit write group because of exception:")
412
trace.log_exception_quietly()
413
note("aborting commit write group: %r" % (e,))
417
self._process_pre_hooks(old_revno, new_revno)
419
# Upload revision data to the master.
420
# this will propagate merged revisions too if needed.
421
if self.bound_branch:
422
self._set_progress_stage("Uploading data to master branch")
423
# 'commit' to the master first so a timeout here causes the
424
# local branch to be out of date
425
self.master_branch.import_last_revision_info(
426
self.branch.repository, new_revno, self.rev_id)
428
# and now do the commit locally.
429
self.branch.set_last_revision_info(new_revno, self.rev_id)
431
# Make the working tree be up to date with the branch. This
432
# includes automatic changes scheduled to be made to the tree, such
433
# as updating its basis and unversioning paths that were missing.
434
self.work_tree.unversion(self.deleted_ids)
435
self._set_progress_stage("Updating the working tree")
436
self.work_tree.update_basis_by_delta(self.rev_id,
437
self.builder.get_basis_delta())
438
self.reporter.completed(new_revno, self.rev_id)
439
self._process_post_hooks(old_revno, new_revno)
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()
440
345
return self.rev_id
442
def _select_reporter(self):
443
"""Select the CommitReporter to use."""
445
return NullCommitReporter()
446
return ReportCommitToLog()
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
448
381
def _check_pointless(self):
449
382
if self.allow_pointless:
505
438
# so grab the lock
506
439
self.bound_branch = self.branch
507
440
self.master_branch.lock_write()
508
operation.add_cleanup(self.master_branch.unlock)
510
def _check_out_of_date_tree(self):
511
"""Check that the working tree is up to date.
513
:return: old_revision_number,new_revision_number tuple
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
516
first_tree_parent = self.work_tree.get_parent_ids()[0]
518
# if there are no parents, treat our parent as 'None'
519
# this is so that we still consider the master branch
520
# - in a checkout scenario the tree may have no
521
# parents but the branch may do.
522
first_tree_parent = bzrlib.revision.NULL_REVISION
523
old_revno, master_last = self.master_branch.last_revision_info()
524
if master_last != first_tree_parent:
525
if master_last != bzrlib.revision.NULL_REVISION:
526
raise errors.OutOfDateTree(self.work_tree)
527
if self.branch.repository.has_revision(first_tree_parent):
528
new_revno = old_revno + 1
530
# ghost parents never appear in revision history.
532
return old_revno,new_revno
534
def _process_pre_hooks(self, old_revno, new_revno):
535
"""Process any registered pre commit hooks."""
536
self._set_progress_stage("Running pre_commit hooks")
537
self._process_hooks("pre_commit", old_revno, new_revno)
539
def _process_post_hooks(self, old_revno, new_revno):
540
"""Process any registered post commit hooks."""
541
# Process the post commit hooks, if any
542
self._set_progress_stage("Running post_commit hooks")
543
# old style commit hooks - should be deprecated ? (obsoleted in
545
if self.config.post_commit() is not None:
546
hooks = self.config.post_commit().split(' ')
547
# this would be nicer with twisted.python.reflect.namedAny
549
result = eval(hook + '(branch, rev_id)',
550
{'branch':self.branch,
552
'rev_id':self.rev_id})
553
# process new style post commit hooks
554
self._process_hooks("post_commit", old_revno, new_revno)
556
def _process_hooks(self, hook_name, old_revno, new_revno):
557
if not Branch.hooks[hook_name]:
560
# new style commit hooks:
561
473
if not self.bound_branch:
562
hook_master = self.branch
565
hook_master = self.master_branch
566
hook_local = self.branch
567
# With bound branches, when the master is behind the local branch,
568
# the 'old_revno' and old_revid values here are incorrect.
569
# XXX: FIXME ^. RBC 20060206
571
old_revid = self.parents[0]
573
old_revid = bzrlib.revision.NULL_REVISION
575
if hook_name == "pre_commit":
576
future_tree = self.builder.revision_tree()
577
tree_delta = future_tree.changes_from(self.basis_tree,
580
for hook in Branch.hooks[hook_name]:
581
# show the running hook in the progress bar. As hooks may
582
# end up doing nothing (e.g. because they are not configured by
583
# the user) this is still showing progress, not showing overall
584
# actions - its up to each plugin to show a UI if it want's to
585
# (such as 'Emailing diff to foo@example.com').
586
self.pb_stage_name = "Running %s hooks [%s]" % \
587
(hook_name, Branch.hooks.get_hook_name(hook))
588
self._emit_progress()
589
if 'hooks' in debug.debug_flags:
590
mutter("Invoking commit hook: %r", hook)
591
if hook_name == "post_commit":
592
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
594
elif hook_name == "pre_commit":
595
hook(hook_local, hook_master,
596
old_revno, old_revid, new_revno, self.rev_id,
597
tree_delta, future_tree)
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)
599
496
def _gather_parents(self):
600
497
"""Record the parents of a merge for merge detection."""
601
# TODO: Make sure that this list doesn't contain duplicate
498
# TODO: Make sure that this list doesn't contain duplicate
602
499
# entries and the order is preserved when doing this.
603
if self.use_record_iter_changes:
605
self.basis_inv = self.basis_tree.inventory
606
self.parent_invs = [self.basis_inv]
607
for revision in self.parents[1:]:
500
self.parents = self.work_tree.get_parent_ids()
501
self.parent_invs = []
502
for revision in self.parents:
608
503
if self.branch.repository.has_revision(revision):
609
504
mutter('commit parent revision {%s}', revision)
610
505
inventory = self.branch.repository.get_inventory(revision)
613
508
mutter('commit parent ghost revision {%s}', revision)
615
def _update_builder_with_changes(self):
616
"""Update the commit builder with the data about what has changed.
618
exclude = self.exclude
619
specific_files = self.specific_files
620
mutter("Selecting files for commit with filter %s", specific_files)
623
if self.use_record_iter_changes:
624
iter_changes = self.work_tree.iter_changes(self.basis_tree,
625
specific_files=specific_files)
626
iter_changes = self._filter_iter_changes(iter_changes)
627
for file_id, path, fs_hash in self.builder.record_iter_changes(
628
self.work_tree, self.basis_revid, iter_changes):
629
self.work_tree._observed_sha1(file_id, path, fs_hash)
631
# Build the new inventory
632
self._populate_from_inventory()
633
self._record_unselected()
634
self._report_and_accumulate_deletes()
636
def _filter_iter_changes(self, iter_changes):
637
"""Process iter_changes.
639
This method reports on the changes in iter_changes to the user, and
640
converts 'missing' entries in the iter_changes iterator to 'deleted'
641
entries. 'missing' entries have their
643
:param iter_changes: An iter_changes to process.
644
:return: A generator of changes.
646
reporter = self.reporter
647
report_changes = reporter.is_verbose()
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
649
for change in iter_changes:
651
old_path = change[1][0]
652
new_path = change[1][1]
653
versioned = change[3][1]
655
versioned = change[3][1]
656
if kind is None and versioned:
659
reporter.missing(new_path)
660
deleted_ids.append(change[0])
661
# Reset the new path (None) and new versioned flag (False)
662
change = (change[0], (change[1][0], None), change[2],
663
(change[3][0], False)) + change[4:]
664
elif kind == 'tree-reference':
665
if self.recursive == 'down':
666
self._commit_nested_tree(change[0], change[1][1])
667
if change[3][0] or change[3][1]:
671
reporter.deleted(old_path)
672
elif old_path is None:
673
reporter.snapshot_change('added', new_path)
674
elif old_path != new_path:
675
reporter.renamed('renamed', old_path, new_path)
678
self.work_tree.branch.repository._format.rich_root_data):
679
# Don't report on changes to '' in non rich root
681
reporter.snapshot_change('modified', new_path)
682
self._next_progress_entry()
683
# Unversion IDs that were found to be deleted
684
self.deleted_ids = deleted_ids
686
def _record_unselected(self):
687
# If specific files are selected, then all un-selected files must be
688
# recorded in their previous state. For more details, see
689
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
690
if self.specific_files or self.exclude:
691
specific_files = self.specific_files or []
692
for path, old_ie in self.basis_inv.iter_entries():
693
if old_ie.file_id in self.builder.new_inventory:
694
# already added - skip.
696
if (is_inside_any(specific_files, path)
697
and not is_inside_any(self.exclude, path)):
698
# was inside the selected path, and not excluded - if not
699
# present it has been deleted so skip.
701
# From here down it was either not selected, or was excluded:
702
# We preserve the entry unaltered.
704
# Note: specific file commits after a merge are currently
705
# prohibited. This test is for sanity/safety in case it's
706
# required after that changes.
707
if len(self.parents) > 1:
709
self.builder.record_entry_contents(ie, self.parent_invs, path,
710
self.basis_tree, None)
712
def _report_and_accumulate_deletes(self):
713
if (isinstance(self.basis_inv, Inventory)
714
and isinstance(self.builder.new_inventory, Inventory)):
715
# the older Inventory classes provide a _byid dict, and building a
716
# set from the keys of this dict is substantially faster than even
717
# getting a set of ids from the inventory
719
# <lifeless> set(dict) is roughly the same speed as
720
# set(iter(dict)) and both are significantly slower than
722
deleted_ids = set(self.basis_inv._byid.keys()) - \
723
set(self.builder.new_inventory._byid.keys())
725
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
727
self.any_entries_deleted = True
728
deleted = [(self.basis_tree.id2path(file_id), file_id)
729
for file_id in deleted_ids]
731
# XXX: this is not quite directory-order sorting
732
for path, file_id in deleted:
733
self.builder.record_delete(path, file_id)
734
self.reporter.deleted(path)
736
def _check_strict(self):
737
# XXX: when we use iter_changes this would likely be faster if
738
# iter_changes would check for us (even in the presence of
741
# raise an exception as soon as we find a single unknown.
742
for unknown in self.work_tree.unknowns():
743
raise StrictCommitFailed()
745
def _populate_from_inventory(self):
746
"""Populate the CommitBuilder by walking the working tree inventory."""
747
# Build the revision inventory.
749
# This starts by creating a new empty inventory. Depending on
750
# which files are selected for commit, and what is present in the
751
# current tree, the new inventory is populated. inventory entries
752
# which are candidates for modification have their revision set to
753
# None; inventory entries that are carried over untouched have their
754
# revision set to their prior value.
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.
756
546
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
757
547
# results to create a new inventory at the same time, which results
758
548
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
759
549
# ADHB 11-07-2006
761
specific_files = self.specific_files
762
exclude = self.exclude
763
report_changes = self.reporter.is_verbose()
765
# A tree of paths that have been deleted. E.g. if foo/bar has been
766
# deleted, then we have {'foo':{'bar':{}}}
768
# XXX: Note that entries may have the wrong kind because the entry does
769
# not reflect the status on disk.
770
work_inv = self.work_tree.inventory
771
# NB: entries will include entries within the excluded ids/paths
772
# because iter_entries_by_dir has no 'exclude' facility today.
773
entries = work_inv.iter_entries_by_dir(
774
specific_file_ids=self.specific_file_ids, yield_parents=True)
775
for path, existing_ie in entries:
776
file_id = existing_ie.file_id
777
name = existing_ie.name
778
parent_id = existing_ie.parent_id
779
kind = existing_ie.kind
780
# Skip files that have been deleted from the working tree.
781
# The deleted path ids are also recorded so they can be explicitly
784
path_segments = splitpath(path)
785
deleted_dict = deleted_paths
786
for segment in path_segments:
787
deleted_dict = deleted_dict.get(segment, None)
789
# We either took a path not present in the dict
790
# (deleted_dict was None), or we've reached an empty
791
# child dir in the dict, so are now a sub-path.
795
if deleted_dict is not None:
796
# the path has a deleted parent, do not add it.
798
if exclude and is_inside_any(exclude, path):
799
# Skip excluded paths. Excluded paths are processed by
800
# _update_builder_with_changes.
802
content_summary = self.work_tree.path_content_summary(path)
803
kind = content_summary[0]
804
# Note that when a filter of specific files is given, we must only
805
# skip/record deleted files matching that filter.
806
if not specific_files or is_inside_any(specific_files, path):
807
if kind == 'missing':
808
if not deleted_paths:
809
# path won't have been split yet.
810
path_segments = splitpath(path)
811
deleted_dict = deleted_paths
812
for segment in path_segments:
813
deleted_dict = deleted_dict.setdefault(segment, {})
814
self.reporter.missing(path)
815
self._next_progress_entry()
816
deleted_ids.append(file_id)
818
# TODO: have the builder do the nested commit just-in-time IF and
820
if kind == 'tree-reference':
821
# enforce repository nested tree policy.
822
if (not self.work_tree.supports_tree_reference() or
823
# repository does not support it either.
824
not self.branch.repository._format.supports_tree_reference):
826
content_summary = (kind, None, None, None)
827
elif self.recursive == 'down':
828
nested_revision_id = self._commit_nested_tree(
830
content_summary = (kind, None, None, nested_revision_id)
832
nested_revision_id = self.work_tree.get_reference_revision(file_id)
833
content_summary = (kind, None, None, nested_revision_id)
835
# Record an entry for this item
836
# Note: I don't particularly want to have the existing_ie
837
# parameter but the test suite currently (28-Jun-07) breaks
838
# without it thanks to a unicode normalisation issue. :-(
839
definitely_changed = kind != existing_ie.kind
840
self._record_entry(path, file_id, specific_files, kind, name,
841
parent_id, definitely_changed, existing_ie, report_changes,
844
# Unversion IDs that were found to be deleted
845
self.deleted_ids = deleted_ids
847
def _commit_nested_tree(self, file_id, path):
848
"Commit a nested tree."
849
sub_tree = self.work_tree.get_nested_tree(file_id, path)
850
# FIXME: be more comprehensive here:
851
# this works when both trees are in --trees repository,
852
# but when both are bound to a different repository,
853
# it fails; a better way of approaching this is to
854
# finally implement the explicit-caches approach design
855
# a while back - RBC 20070306.
856
if sub_tree.branch.repository.has_same_location(
857
self.work_tree.branch.repository):
858
sub_tree.branch.repository = \
859
self.work_tree.branch.repository
861
return sub_tree.commit(message=None, revprops=self.revprops,
862
recursive=self.recursive,
863
message_callback=self.message_callback,
864
timestamp=self.timestamp, timezone=self.timezone,
865
committer=self.committer,
866
allow_pointless=self.allow_pointless,
867
strict=self.strict, verbose=self.verbose,
868
local=self.local, reporter=self.reporter)
869
except errors.PointlessCommit:
870
return self.work_tree.get_reference_revision(file_id)
872
def _record_entry(self, path, file_id, specific_files, kind, name,
873
parent_id, definitely_changed, existing_ie, report_changes,
875
"Record the new inventory entry for a path if any."
876
# mutter('check %s {%s}', path, file_id)
877
# mutter('%s selected for commit', path)
878
if definitely_changed or existing_ie is None:
879
ie = make_entry(kind, name, parent_id, file_id)
881
ie = existing_ie.copy()
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):
882
602
ie.revision = None
883
# For carried over entries we don't care about the fs hash - the repo
884
# isn't generating a sha, so we're not saving computation time.
885
_, _, fs_hash = self.builder.record_entry_contents(
886
ie, self.parent_invs, path, self.work_tree, content_summary)
888
self._report_change(ie, path)
890
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
893
def _report_change(self, ie, path):
894
"""Report a change to the user.
896
The change that has occurred is described relative to the basis
899
if (self.basis_inv.has_id(ie.file_id)):
900
basis_ie = self.basis_inv[ie.file_id]
903
change = ie.describe_change(basis_ie, ie)
904
if change in (InventoryEntry.RENAMED,
905
InventoryEntry.MODIFIED_AND_RENAMED):
906
old_path = self.basis_inv.id2path(ie.file_id)
907
self.reporter.renamed(change, old_path, path)
908
self._next_progress_entry()
910
if change == 'unchanged':
912
self.reporter.snapshot_change(change, path)
913
self._next_progress_entry()
915
def _set_progress_stage(self, name, counter=False):
916
"""Set the progress stage and emit an update to the progress bar."""
917
self.pb_stage_name = name
918
self.pb_stage_count += 1
920
self.pb_entries_count = 0
922
self.pb_entries_count = None
923
self._emit_progress()
925
def _next_progress_entry(self):
926
"""Emit an update to the progress bar and increment the entry count."""
927
self.pb_entries_count += 1
928
self._emit_progress()
930
def _emit_progress(self):
931
if self.pb_entries_count is not None:
932
text = "%s [%d] - Stage" % (self.pb_stage_name,
933
self.pb_entries_count)
935
text = "%s - Stage" % (self.pb_stage_name, )
936
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
938
def _set_specific_file_ids(self):
939
"""populate self.specific_file_ids if we will use it."""
940
if not self.use_record_iter_changes:
941
# If provided, ensure the specified files are versioned
942
if self.specific_files is not None:
943
# Note: This routine is being called because it raises
944
# PathNotVersionedError as a side effect of finding the IDs. We
945
# later use the ids we found as input to the working tree
946
# inventory iterator, so we only consider those ids rather than
947
# examining the whole tree again.
948
# XXX: Dont we have filter_unversioned to do this more
950
self.specific_file_ids = tree.find_ids_across_trees(
951
self.specific_files, [self.basis_tree, self.work_tree])
953
self.specific_file_ids = 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)
added
removed
bzrlib/commit.py
