224
184
working_tree=None,
228
message_callback=None,
231
possible_master_transports=None,
233
188
"""Commit working copy as a new revision.
235
:param message: the commit message (it or message_callback is required)
236
:param message_callback: A callback: message = message_callback(cmt_obj)
238
:param timestamp: if not None, seconds-since-epoch for a
239
postdated/predated commit.
241
:param specific_files: If not None, commit only those files. An empty
242
list means 'commit no files'.
244
:param rev_id: If set, use this as the new revision id.
190
branch -- the deprecated branch to commit to. New callers should pass in
193
message -- the commit message, a mandatory parameter
195
timestamp -- if not None, seconds-since-epoch for a
196
postdated/predated commit.
198
specific_files -- If true, commit only those files.
200
rev_id -- If set, use this as the new revision id.
245
201
Useful for test or import commands that need to tightly
246
202
control what revisions are assigned. If you duplicate
247
203
a revision id that exists elsewhere it is your own fault.
248
204
If null (default), a time/random revision id is generated.
250
:param allow_pointless: If true (default), commit even if nothing
206
allow_pointless -- If true (default), commit even if nothing
251
207
has changed and no merges are recorded.
253
:param strict: If true, don't allow a commit if the working tree
209
strict -- If true, don't allow a commit if the working tree
254
210
contains unknown files.
256
:param revprops: Properties for new revision
212
revprops -- Properties for new revision
257
213
:param local: Perform a local only commit.
258
:param reporter: the reporter to use or None for the default
259
:param verbose: if True and the reporter is not None, report everything
260
:param recursive: If set to 'down', commit in any subtrees that have
261
pending changes of any sort during this commit.
262
:param exclude: None or a list of relative paths to exclude from the
263
commit. Pending changes to excluded files will be ignored by the
265
:param lossy: When committing to a foreign VCS, ignore any
266
data that can not be natively represented.
268
operation = OperationWithCleanups(self._commit)
269
self.revprops = revprops or {}
270
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
271
self.config = config or self.config
272
return operation.run(
277
specific_files=specific_files,
279
allow_pointless=allow_pointless,
282
working_tree=working_tree,
285
message_callback=message_callback,
288
possible_master_transports=possible_master_transports,
291
def _commit(self, operation, message, timestamp, timezone, committer,
292
specific_files, rev_id, allow_pointless, strict, verbose,
293
working_tree, local, reporter, message_callback, recursive,
294
exclude, possible_master_transports, lossy):
295
215
mutter('preparing to commit')
297
if working_tree is None:
298
raise BzrError("working_tree must be passed into commit().")
217
if deprecated_passed(branch):
218
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
219
"deprecated as of bzr 0.8. Please use working_tree= instead.",
220
DeprecationWarning, stacklevel=2)
222
self.work_tree = self.branch.bzrdir.open_workingtree()
223
elif working_tree is None:
224
raise BzrError("One of branch and working_tree must be passed into commit().")
300
226
self.work_tree = working_tree
301
227
self.branch = self.work_tree.branch
302
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
303
if not self.branch.repository.supports_rich_root():
304
raise errors.RootNotRich()
305
if message_callback is None:
306
if message is not None:
307
if isinstance(message, str):
308
message = message.decode(get_user_encoding())
309
message_callback = lambda x: message
311
raise BzrError("The message or message_callback keyword"
312
" parameter is required for commit().")
229
raise BzrError("The message keyword parameter is required for commit().")
314
231
self.bound_branch = None
315
self.any_entries_deleted = False
316
if exclude is not None:
317
self.exclude = sorted(
318
minimum_path_selection(exclude))
321
232
self.local = local
322
233
self.master_branch = None
323
self.recursive = recursive
234
self.master_locked = False
324
235
self.rev_id = None
325
# self.specific_files is None to indicate no filter, or any iterable to
326
# indicate a filter - [] means no files at all, as per iter_changes.
327
if specific_files is not None:
328
self.specific_files = sorted(
329
minimum_path_selection(specific_files))
331
self.specific_files = None
236
self.specific_files = specific_files
333
237
self.allow_pointless = allow_pointless
334
self.message_callback = message_callback
335
self.timestamp = timestamp
336
self.timezone = timezone
337
self.committer = committer
339
self.verbose = verbose
239
if reporter is None and self.reporter is None:
240
self.reporter = NullCommitReporter()
241
elif reporter is not None:
242
self.reporter = reporter
341
244
self.work_tree.lock_write()
342
operation.add_cleanup(self.work_tree.unlock)
343
self.parents = self.work_tree.get_parent_ids()
344
# We can use record_iter_changes IFF iter_changes is compatible with
345
# the command line parameters, and the repository has fast delta
346
# generation. See bug 347649.
347
self.use_record_iter_changes = (
349
not self.branch.repository._format.supports_tree_reference and
350
(self.branch.repository._format.fast_deltas or
351
len(self.parents) < 2))
352
self.pb = ui.ui_factory.nested_progress_bar()
353
operation.add_cleanup(self.pb.finished)
354
self.basis_revid = self.work_tree.last_revision()
355
self.basis_tree = self.work_tree.basis_tree()
356
self.basis_tree.lock_read()
357
operation.add_cleanup(self.basis_tree.unlock)
358
# Cannot commit with conflicts present.
359
if len(self.work_tree.conflicts()) > 0:
360
raise ConflictsInTree
362
# Setup the bound branch variables as needed.
363
self._check_bound_branch(operation, possible_master_transports)
365
# Check that the working tree is up to date
366
old_revno, new_revno = self._check_out_of_date_tree()
368
# Complete configuration setup
369
if reporter is not None:
370
self.reporter = reporter
371
elif self.reporter is None:
372
self.reporter = self._select_reporter()
373
if self.config is None:
374
self.config = self.branch.get_config()
376
self._set_specific_file_ids()
378
# Setup the progress bar. As the number of files that need to be
379
# committed in unknown, progress is reported as stages.
380
# We keep track of entries separately though and include that
381
# information in the progress bar during the relevant stages.
382
self.pb_stage_name = ""
383
self.pb_stage_count = 0
384
self.pb_stage_total = 5
385
if self.bound_branch:
386
# 2 extra stages: "Uploading data to master branch" and "Merging
387
# tags to master branch"
388
self.pb_stage_total += 2
389
self.pb.show_pct = False
390
self.pb.show_spinner = False
391
self.pb.show_eta = False
392
self.pb.show_count = True
393
self.pb.show_bar = True
395
self._gather_parents()
396
# After a merge, a selected file commit is not supported.
397
# See 'bzr help merge' for an explanation as to why.
398
if len(self.parents) > 1 and self.specific_files is not None:
399
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
400
# Excludes are a form of selected file commit.
401
if len(self.parents) > 1 and self.exclude:
402
raise errors.CannotCommitSelectedFileMerge(self.exclude)
404
# Collect the changes
405
self._set_progress_stage("Collecting changes", counter=True)
407
self.builder = self.branch.get_commit_builder(self.parents,
408
self.config, timestamp, timezone, committer, self.revprops,
410
if not self.builder.supports_record_entry_contents and self.exclude:
412
raise errors.ExcludesUnsupported(self.branch.repository)
245
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
415
self.builder.will_record_deletes()
416
# find the location being committed to
417
if self.bound_branch:
418
master_location = self.master_branch.base
420
master_location = self.branch.base
422
# report the start of the commit
423
self.reporter.started(new_revno, self.rev_id, master_location)
425
self._update_builder_with_changes()
247
# Cannot commit with conflicts present.
248
if len(self.work_tree.conflicts())>0:
249
raise ConflictsInTree
251
# setup the bound branch variables as needed.
252
self._check_bound_branch()
254
# check for out of date working trees
256
first_tree_parent = self.work_tree.get_parent_ids()[0]
258
# if there are no parents, treat our parent as 'None'
259
# this is so that we still consier the master branch
260
# - in a checkout scenario the tree may have no
261
# parents but the branch may do.
262
first_tree_parent = None
263
master_last = self.master_branch.last_revision()
264
if (master_last is not None and
265
master_last != first_tree_parent):
266
raise errors.OutOfDateTree(self.work_tree)
269
# raise an exception as soon as we find a single unknown.
270
for unknown in self.work_tree.unknowns():
271
raise StrictCommitFailed()
273
if self.config is None:
274
self.config = self.branch.get_config()
276
if isinstance(message, str):
277
message = message.decode(bzrlib.user_encoding)
278
assert isinstance(message, unicode), type(message)
279
self.message = message
280
self._escape_commit_message()
282
self.work_inv = self.work_tree.inventory
283
self.basis_tree = self.work_tree.basis_tree()
284
self.basis_inv = self.basis_tree.inventory
285
if specific_files is not None:
286
# Ensure specified files are versioned
287
# (We don't actually need the ids here)
288
tree.find_ids_across_trees(specific_files,
289
[self.basis_tree, self.work_tree])
290
# one to finish, one for rev and inventory, and one for each
291
# inventory entry, and the same for the new inventory.
292
# note that this estimate is too long when we do a partial tree
293
# commit which excludes some new files from being considered.
294
# The estimate is corrected when we populate the new inv.
295
self.pb_total = len(self.work_inv) + 5
298
self._gather_parents()
299
if len(self.parents) > 1 and self.specific_files:
300
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
303
self.builder = self.branch.get_commit_builder(self.parents,
304
self.config, timestamp, timezone, committer, revprops, rev_id)
306
self._remove_deleted()
307
self._populate_new_inv()
308
self._report_deletes()
426
310
self._check_pointless()
428
# TODO: Now the new inventory is known, check for conflicts.
312
self._emit_progress_update()
313
# TODO: Now the new inventory is known, check for conflicts and
314
# prompt the user for a commit message.
429
315
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
430
316
# weave lines, because nothing should be recorded until it is known
431
317
# that commit will succeed.
432
self._set_progress_stage("Saving data locally")
433
318
self.builder.finish_inventory()
435
# Prompt the user for a commit message if none provided
436
message = message_callback(self)
437
self.message = message
439
# Add revision data to the local branch
319
self._emit_progress_update()
440
320
self.rev_id = self.builder.commit(self.message)
443
mutter("aborting commit write group because of exception:")
444
trace.log_exception_quietly()
448
self._process_pre_hooks(old_revno, new_revno)
450
# Upload revision data to the master.
451
# this will propagate merged revisions too if needed.
452
if self.bound_branch:
453
self._set_progress_stage("Uploading data to master branch")
454
# 'commit' to the master first so a timeout here causes the
455
# local branch to be out of date
456
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
457
self.branch, new_revno, self.rev_id, lossy=lossy)
459
self.branch.fetch(self.master_branch, self.rev_id)
461
# and now do the commit locally.
462
self.branch.set_last_revision_info(new_revno, self.rev_id)
464
# Merge local tags to remote
465
if self.bound_branch:
466
self._set_progress_stage("Merging tags to master branch")
467
tag_conflicts = self.branch.tags.merge_to(self.master_branch.tags)
469
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
470
note("Conflicting tags in bound branch:\n" +
471
"\n".join(warning_lines))
473
# Make the working tree be up to date with the branch. This
474
# includes automatic changes scheduled to be made to the tree, such
475
# as updating its basis and unversioning paths that were missing.
476
self.work_tree.unversion(self.deleted_ids)
477
self._set_progress_stage("Updating the working tree")
478
self.work_tree.update_basis_by_delta(self.rev_id,
479
self.builder.get_basis_delta())
480
self.reporter.completed(new_revno, self.rev_id)
481
self._process_post_hooks(old_revno, new_revno)
321
self._emit_progress_update()
322
# revision data is in the local branch now.
324
# upload revision data to the master.
325
# this will propagate merged revisions too if needed.
326
if self.bound_branch:
327
self.master_branch.repository.fetch(self.branch.repository,
328
revision_id=self.rev_id)
329
# now the master has the revision data
330
# 'commit' to the master first so a timeout here causes the local
331
# branch to be out of date
332
self.master_branch.append_revision(self.rev_id)
334
# and now do the commit locally.
335
self.branch.append_revision(self.rev_id)
337
rev_tree = self.builder.revision_tree()
338
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
339
# now the work tree is up to date with the branch
341
self.reporter.completed(self.branch.revno(), self.rev_id)
342
if self.config.post_commit() is not None:
343
hooks = self.config.post_commit().split(' ')
344
# this would be nicer with twisted.python.reflect.namedAny
346
result = eval(hook + '(branch, rev_id)',
347
{'branch':self.branch,
349
'rev_id':self.rev_id})
350
self._emit_progress_update()
482
353
return self.rev_id
484
def _select_reporter(self):
485
"""Select the CommitReporter to use."""
487
return NullCommitReporter()
488
return ReportCommitToLog()
355
def _any_real_changes(self):
356
"""Are there real changes between new_inventory and basis?
358
For trees without rich roots, inv.root.revision changes every commit.
359
But if that is the only change, we want to treat it as though there
362
new_entries = self.builder.new_inventory.iter_entries()
363
basis_entries = self.basis_inv.iter_entries()
364
new_path, new_root_ie = new_entries.next()
365
basis_path, basis_root_ie = basis_entries.next()
367
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
368
def ie_equal_no_revision(this, other):
369
return ((this.file_id == other.file_id)
370
and (this.name == other.name)
371
and (this.symlink_target == other.symlink_target)
372
and (this.text_sha1 == other.text_sha1)
373
and (this.text_size == other.text_size)
374
and (this.text_id == other.text_id)
375
and (this.parent_id == other.parent_id)
376
and (this.kind == other.kind)
377
and (this.executable == other.executable)
379
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
382
for new_ie, basis_ie in zip(new_entries, basis_entries):
383
if new_ie != basis_ie:
386
# No actual changes present
490
389
def _check_pointless(self):
491
390
if self.allow_pointless:
538
446
# so grab the lock
539
447
self.bound_branch = self.branch
540
448
self.master_branch.lock_write()
541
operation.add_cleanup(self.master_branch.unlock)
543
def _check_out_of_date_tree(self):
544
"""Check that the working tree is up to date.
546
:return: old_revision_number,new_revision_number tuple
449
self.master_locked = True
452
"""Cleanup any open locks, progress bars etc."""
453
cleanups = [self._cleanup_bound_branch,
454
self.work_tree.unlock,
456
found_exception = None
457
for cleanup in cleanups:
460
# we want every cleanup to run no matter what.
461
# so we have a catchall here, but we will raise the
462
# last encountered exception up the stack: and
463
# typically this will be useful enough.
466
if found_exception is not None:
467
# don't do a plan raise, because the last exception may have been
468
# trashed, e is our sure-to-work exception even though it loses the
469
# full traceback. XXX: RBC 20060421 perhaps we could check the
470
# exc_info and if its the same one do a plain raise otherwise
471
# 'raise e' as we do now.
474
def _cleanup_bound_branch(self):
475
"""Executed at the end of a try/finally to cleanup a bound branch.
477
If the branch wasn't bound, this is a no-op.
478
If it was, it resents self.branch to the local branch, instead
549
first_tree_parent = self.work_tree.get_parent_ids()[0]
551
# if there are no parents, treat our parent as 'None'
552
# this is so that we still consider the master branch
553
# - in a checkout scenario the tree may have no
554
# parents but the branch may do.
555
first_tree_parent = bzrlib.revision.NULL_REVISION
556
old_revno, master_last = self.master_branch.last_revision_info()
557
if master_last != first_tree_parent:
558
if master_last != bzrlib.revision.NULL_REVISION:
559
raise errors.OutOfDateTree(self.work_tree)
560
if self.branch.repository.has_revision(first_tree_parent):
561
new_revno = old_revno + 1
563
# ghost parents never appear in revision history.
565
return old_revno,new_revno
567
def _process_pre_hooks(self, old_revno, new_revno):
568
"""Process any registered pre commit hooks."""
569
self._set_progress_stage("Running pre_commit hooks")
570
self._process_hooks("pre_commit", old_revno, new_revno)
572
def _process_post_hooks(self, old_revno, new_revno):
573
"""Process any registered post commit hooks."""
574
# Process the post commit hooks, if any
575
self._set_progress_stage("Running post_commit hooks")
576
# old style commit hooks - should be deprecated ? (obsoleted in
578
if self.config.post_commit() is not None:
579
hooks = self.config.post_commit().split(' ')
580
# this would be nicer with twisted.python.reflect.namedAny
582
result = eval(hook + '(branch, rev_id)',
583
{'branch':self.branch,
585
'rev_id':self.rev_id})
586
# process new style post commit hooks
587
self._process_hooks("post_commit", old_revno, new_revno)
589
def _process_hooks(self, hook_name, old_revno, new_revno):
590
if not Branch.hooks[hook_name]:
593
# new style commit hooks:
594
481
if not self.bound_branch:
595
hook_master = self.branch
598
hook_master = self.master_branch
599
hook_local = self.branch
600
# With bound branches, when the master is behind the local branch,
601
# the 'old_revno' and old_revid values here are incorrect.
602
# XXX: FIXME ^. RBC 20060206
604
old_revid = self.parents[0]
606
old_revid = bzrlib.revision.NULL_REVISION
608
if hook_name == "pre_commit":
609
future_tree = self.builder.revision_tree()
610
tree_delta = future_tree.changes_from(self.basis_tree,
613
for hook in Branch.hooks[hook_name]:
614
# show the running hook in the progress bar. As hooks may
615
# end up doing nothing (e.g. because they are not configured by
616
# the user) this is still showing progress, not showing overall
617
# actions - its up to each plugin to show a UI if it want's to
618
# (such as 'Emailing diff to foo@example.com').
619
self.pb_stage_name = "Running %s hooks [%s]" % \
620
(hook_name, Branch.hooks.get_hook_name(hook))
621
self._emit_progress()
622
if 'hooks' in debug.debug_flags:
623
mutter("Invoking commit hook: %r", hook)
624
if hook_name == "post_commit":
625
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
627
elif hook_name == "pre_commit":
628
hook(hook_local, hook_master,
629
old_revno, old_revid, new_revno, self.rev_id,
630
tree_delta, future_tree)
483
if self.master_locked:
484
self.master_branch.unlock()
486
def _escape_commit_message(self):
487
"""Replace xml-incompatible control characters."""
488
# FIXME: RBC 20060419 this should be done by the revision
489
# serialiser not by commit. Then we can also add an unescaper
490
# in the deserializer and start roundtripping revision messages
491
# precisely. See repository_implementations/test_repository.py
493
# Python strings can include characters that can't be
494
# represented in well-formed XML; escape characters that
495
# aren't listed in the XML specification
496
# (http://www.w3.org/TR/REC-xml/#NT-Char).
497
self.message, escape_count = re.subn(
498
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
499
lambda match: match.group(0).encode('unicode_escape'),
502
self.reporter.escaped(escape_count, self.message)
632
504
def _gather_parents(self):
633
505
"""Record the parents of a merge for merge detection."""
634
# TODO: Make sure that this list doesn't contain duplicate
506
# TODO: Make sure that this list doesn't contain duplicate
635
507
# entries and the order is preserved when doing this.
636
if self.use_record_iter_changes:
638
self.basis_inv = self.basis_tree.inventory
639
self.parent_invs = [self.basis_inv]
640
for revision in self.parents[1:]:
508
self.parents = self.work_tree.get_parent_ids()
509
self.parent_invs = []
510
for revision in self.parents:
641
511
if self.branch.repository.has_revision(revision):
642
512
mutter('commit parent revision {%s}', revision)
643
513
inventory = self.branch.repository.get_inventory(revision)
646
516
mutter('commit parent ghost revision {%s}', revision)
648
def _update_builder_with_changes(self):
649
"""Update the commit builder with the data about what has changed.
651
exclude = self.exclude
652
specific_files = self.specific_files
653
mutter("Selecting files for commit with filter %s", specific_files)
656
if self.use_record_iter_changes:
657
iter_changes = self.work_tree.iter_changes(self.basis_tree,
658
specific_files=specific_files)
659
iter_changes = self._filter_iter_changes(iter_changes)
660
for file_id, path, fs_hash in self.builder.record_iter_changes(
661
self.work_tree, self.basis_revid, iter_changes):
662
self.work_tree._observed_sha1(file_id, path, fs_hash)
664
# Build the new inventory
665
self._populate_from_inventory()
666
self._record_unselected()
667
self._report_and_accumulate_deletes()
669
def _filter_iter_changes(self, iter_changes):
670
"""Process iter_changes.
672
This method reports on the changes in iter_changes to the user, and
673
converts 'missing' entries in the iter_changes iterator to 'deleted'
674
entries. 'missing' entries have their
676
:param iter_changes: An iter_changes to process.
677
:return: A generator of changes.
679
reporter = self.reporter
680
report_changes = reporter.is_verbose()
518
def _remove_deleted(self):
519
"""Remove deleted files from the working inventories.
521
This is done prior to taking the working inventory as the
522
basis for the new committed inventory.
524
This returns true if any files
525
*that existed in the basis inventory* were deleted.
526
Files that were added and deleted
527
in the working copy don't matter.
529
specific = self.specific_files
682
for change in iter_changes:
684
old_path = change[1][0]
685
new_path = change[1][1]
686
versioned = change[3][1]
688
versioned = change[3][1]
689
if kind is None and versioned:
692
reporter.missing(new_path)
693
deleted_ids.append(change[0])
694
# Reset the new path (None) and new versioned flag (False)
695
change = (change[0], (change[1][0], None), change[2],
696
(change[3][0], False)) + change[4:]
697
elif kind == 'tree-reference':
698
if self.recursive == 'down':
699
self._commit_nested_tree(change[0], change[1][1])
700
if change[3][0] or change[3][1]:
704
reporter.deleted(old_path)
705
elif old_path is None:
706
reporter.snapshot_change('added', new_path)
707
elif old_path != new_path:
708
reporter.renamed('renamed', old_path, new_path)
711
self.work_tree.branch.repository._format.rich_root_data):
712
# Don't report on changes to '' in non rich root
714
reporter.snapshot_change('modified', new_path)
715
self._next_progress_entry()
716
# Unversion IDs that were found to be deleted
717
self.deleted_ids = deleted_ids
719
def _record_unselected(self):
720
# If specific files are selected, then all un-selected files must be
721
# recorded in their previous state. For more details, see
722
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
723
if self.specific_files or self.exclude:
724
specific_files = self.specific_files or []
725
for path, old_ie in self.basis_inv.iter_entries():
726
if self.builder.new_inventory.has_id(old_ie.file_id):
727
# already added - skip.
729
if (is_inside_any(specific_files, path)
730
and not is_inside_any(self.exclude, path)):
731
# was inside the selected path, and not excluded - if not
732
# present it has been deleted so skip.
734
# From here down it was either not selected, or was excluded:
735
# We preserve the entry unaltered.
737
# Note: specific file commits after a merge are currently
738
# prohibited. This test is for sanity/safety in case it's
739
# required after that changes.
740
if len(self.parents) > 1:
742
self.builder.record_entry_contents(ie, self.parent_invs, path,
743
self.basis_tree, None)
745
def _report_and_accumulate_deletes(self):
746
if (isinstance(self.basis_inv, Inventory)
747
and isinstance(self.builder.new_inventory, Inventory)):
748
# the older Inventory classes provide a _byid dict, and building a
749
# set from the keys of this dict is substantially faster than even
750
# getting a set of ids from the inventory
752
# <lifeless> set(dict) is roughly the same speed as
753
# set(iter(dict)) and both are significantly slower than
755
deleted_ids = set(self.basis_inv._byid.keys()) - \
756
set(self.builder.new_inventory._byid.keys())
758
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
760
self.any_entries_deleted = True
761
deleted = [(self.basis_tree.id2path(file_id), file_id)
762
for file_id in deleted_ids]
764
# XXX: this is not quite directory-order sorting
765
for path, file_id in deleted:
766
self.builder.record_delete(path, file_id)
767
self.reporter.deleted(path)
769
def _check_strict(self):
770
# XXX: when we use iter_changes this would likely be faster if
771
# iter_changes would check for us (even in the presence of
774
# raise an exception as soon as we find a single unknown.
775
for unknown in self.work_tree.unknowns():
776
raise StrictCommitFailed()
778
def _populate_from_inventory(self):
779
"""Populate the CommitBuilder by walking the working tree inventory."""
780
# Build the revision inventory.
782
# This starts by creating a new empty inventory. Depending on
783
# which files are selected for commit, and what is present in the
784
# current tree, the new inventory is populated. inventory entries
785
# which are candidates for modification have their revision set to
786
# None; inventory entries that are carried over untouched have their
787
# revision set to their prior value.
531
deleted_paths = set()
532
for path, ie in self.work_inv.iter_entries():
533
if is_inside_any(deleted_paths, path):
534
# The tree will delete the required ids recursively.
536
if specific and not is_inside_any(specific, path):
538
if not self.work_tree.has_filename(path):
539
deleted_paths.add(path)
540
self.reporter.missing(path)
541
deleted_ids.append(ie.file_id)
542
self.work_tree.unversion(deleted_ids)
544
def _populate_new_inv(self):
545
"""Build revision inventory.
547
This creates a new empty inventory. Depending on
548
which files are selected for commit, and what is present in the
549
current tree, the new inventory is populated. inventory entries
550
which are candidates for modification have their revision set to
551
None; inventory entries that are carried over untouched have their
552
revision set to their prior value.
789
554
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
790
555
# results to create a new inventory at the same time, which results
791
556
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
792
557
# ADHB 11-07-2006
794
specific_files = self.specific_files
795
exclude = self.exclude
796
report_changes = self.reporter.is_verbose()
798
# A tree of paths that have been deleted. E.g. if foo/bar has been
799
# deleted, then we have {'foo':{'bar':{}}}
801
# XXX: Note that entries may have the wrong kind because the entry does
802
# not reflect the status on disk.
803
work_inv = self.work_tree.inventory
804
# NB: entries will include entries within the excluded ids/paths
805
# because iter_entries_by_dir has no 'exclude' facility today.
806
entries = work_inv.iter_entries_by_dir(
807
specific_file_ids=self.specific_file_ids, yield_parents=True)
808
for path, existing_ie in entries:
809
file_id = existing_ie.file_id
810
name = existing_ie.name
811
parent_id = existing_ie.parent_id
812
kind = existing_ie.kind
813
# Skip files that have been deleted from the working tree.
814
# The deleted path ids are also recorded so they can be explicitly
817
path_segments = splitpath(path)
818
deleted_dict = deleted_paths
819
for segment in path_segments:
820
deleted_dict = deleted_dict.get(segment, None)
822
# We either took a path not present in the dict
823
# (deleted_dict was None), or we've reached an empty
824
# child dir in the dict, so are now a sub-path.
828
if deleted_dict is not None:
829
# the path has a deleted parent, do not add it.
831
if exclude and is_inside_any(exclude, path):
832
# Skip excluded paths. Excluded paths are processed by
833
# _update_builder_with_changes.
835
content_summary = self.work_tree.path_content_summary(path)
836
kind = content_summary[0]
837
# Note that when a filter of specific files is given, we must only
838
# skip/record deleted files matching that filter.
839
if not specific_files or is_inside_any(specific_files, path):
840
if kind == 'missing':
841
if not deleted_paths:
842
# path won't have been split yet.
843
path_segments = splitpath(path)
844
deleted_dict = deleted_paths
845
for segment in path_segments:
846
deleted_dict = deleted_dict.setdefault(segment, {})
847
self.reporter.missing(path)
848
self._next_progress_entry()
849
deleted_ids.append(file_id)
851
# TODO: have the builder do the nested commit just-in-time IF and
853
if kind == 'tree-reference':
854
# enforce repository nested tree policy.
855
if (not self.work_tree.supports_tree_reference() or
856
# repository does not support it either.
857
not self.branch.repository._format.supports_tree_reference):
859
content_summary = (kind, None, None, None)
860
elif self.recursive == 'down':
861
nested_revision_id = self._commit_nested_tree(
863
content_summary = (kind, None, None, nested_revision_id)
865
nested_revision_id = self.work_tree.get_reference_revision(file_id)
866
content_summary = (kind, None, None, nested_revision_id)
868
# Record an entry for this item
869
# Note: I don't particularly want to have the existing_ie
870
# parameter but the test suite currently (28-Jun-07) breaks
871
# without it thanks to a unicode normalisation issue. :-(
872
definitely_changed = kind != existing_ie.kind
873
self._record_entry(path, file_id, specific_files, kind, name,
874
parent_id, definitely_changed, existing_ie, report_changes,
877
# Unversion IDs that were found to be deleted
878
self.deleted_ids = deleted_ids
880
def _commit_nested_tree(self, file_id, path):
881
"Commit a nested tree."
882
sub_tree = self.work_tree.get_nested_tree(file_id, path)
883
# FIXME: be more comprehensive here:
884
# this works when both trees are in --trees repository,
885
# but when both are bound to a different repository,
886
# it fails; a better way of approaching this is to
887
# finally implement the explicit-caches approach design
888
# a while back - RBC 20070306.
889
if sub_tree.branch.repository.has_same_location(
890
self.work_tree.branch.repository):
891
sub_tree.branch.repository = \
892
self.work_tree.branch.repository
894
return sub_tree.commit(message=None, revprops=self.revprops,
895
recursive=self.recursive,
896
message_callback=self.message_callback,
897
timestamp=self.timestamp, timezone=self.timezone,
898
committer=self.committer,
899
allow_pointless=self.allow_pointless,
900
strict=self.strict, verbose=self.verbose,
901
local=self.local, reporter=self.reporter)
902
except errors.PointlessCommit:
903
return self.work_tree.get_reference_revision(file_id)
905
def _record_entry(self, path, file_id, specific_files, kind, name,
906
parent_id, definitely_changed, existing_ie, report_changes,
908
"Record the new inventory entry for a path if any."
909
# mutter('check %s {%s}', path, file_id)
910
# mutter('%s selected for commit', path)
911
if definitely_changed or existing_ie is None:
912
ie = make_entry(kind, name, parent_id, file_id)
914
ie = existing_ie.copy()
558
mutter("Selecting files for commit with filter %s", self.specific_files)
559
assert self.work_inv.root is not None
560
entries = self.work_inv.iter_entries()
561
if not self.builder.record_root_entry:
562
symbol_versioning.warn('CommitBuilders should support recording'
563
' the root entry as of bzr 0.10.', DeprecationWarning,
565
self.builder.new_inventory.add(self.basis_inv.root.copy())
567
self._emit_progress_update()
568
for path, new_ie in entries:
569
self._emit_progress_update()
570
file_id = new_ie.file_id
571
# mutter('check %s {%s}', path, file_id)
572
if (not self.specific_files or
573
is_inside_or_parent_of_any(self.specific_files, path)):
574
# mutter('%s selected for commit', path)
578
# mutter('%s not selected for commit', path)
579
if self.basis_inv.has_id(file_id):
580
ie = self.basis_inv[file_id].copy()
582
# this entry is new and not being committed
584
self.builder.record_entry_contents(ie, self.parent_invs,
585
path, self.work_tree)
586
# describe the nature of the change that has occurred relative to
587
# the basis inventory.
588
if (self.basis_inv.has_id(ie.file_id)):
589
basis_ie = self.basis_inv[ie.file_id]
592
change = ie.describe_change(basis_ie, ie)
593
if change in (InventoryEntry.RENAMED,
594
InventoryEntry.MODIFIED_AND_RENAMED):
595
old_path = self.basis_inv.id2path(ie.file_id)
596
self.reporter.renamed(change, old_path, path)
598
self.reporter.snapshot_change(change, path)
600
if not self.specific_files:
603
# ignore removals that don't match filespec
604
for path, new_ie in self.basis_inv.iter_entries():
605
if new_ie.file_id in self.work_inv:
607
if is_inside_any(self.specific_files, path):
915
610
ie.revision = None
916
# For carried over entries we don't care about the fs hash - the repo
917
# isn't generating a sha, so we're not saving computation time.
918
_, _, fs_hash = self.builder.record_entry_contents(
919
ie, self.parent_invs, path, self.work_tree, content_summary)
921
self._report_change(ie, path)
923
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
926
def _report_change(self, ie, path):
927
"""Report a change to the user.
929
The change that has occurred is described relative to the basis
932
if (self.basis_inv.has_id(ie.file_id)):
933
basis_ie = self.basis_inv[ie.file_id]
936
change = ie.describe_change(basis_ie, ie)
937
if change in (InventoryEntry.RENAMED,
938
InventoryEntry.MODIFIED_AND_RENAMED):
939
old_path = self.basis_inv.id2path(ie.file_id)
940
self.reporter.renamed(change, old_path, path)
941
self._next_progress_entry()
943
if change == 'unchanged':
945
self.reporter.snapshot_change(change, path)
946
self._next_progress_entry()
948
def _set_progress_stage(self, name, counter=False):
949
"""Set the progress stage and emit an update to the progress bar."""
950
self.pb_stage_name = name
951
self.pb_stage_count += 1
953
self.pb_entries_count = 0
955
self.pb_entries_count = None
956
self._emit_progress()
958
def _next_progress_entry(self):
959
"""Emit an update to the progress bar and increment the entry count."""
960
self.pb_entries_count += 1
961
self._emit_progress()
963
def _emit_progress(self):
964
if self.pb_entries_count is not None:
965
text = "%s [%d] - Stage" % (self.pb_stage_name,
966
self.pb_entries_count)
968
text = "%s - Stage" % (self.pb_stage_name, )
969
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
971
def _set_specific_file_ids(self):
972
"""populate self.specific_file_ids if we will use it."""
973
if not self.use_record_iter_changes:
974
# If provided, ensure the specified files are versioned
975
if self.specific_files is not None:
976
# Note: This routine is being called because it raises
977
# PathNotVersionedError as a side effect of finding the IDs. We
978
# later use the ids we found as input to the working tree
979
# inventory iterator, so we only consider those ids rather than
980
# examining the whole tree again.
981
# XXX: Dont we have filter_unversioned to do this more
983
self.specific_file_ids = tree.find_ids_across_trees(
984
self.specific_files, [self.basis_tree, self.work_tree])
986
self.specific_file_ids = None
611
self.builder.record_entry_contents(ie, self.parent_invs, path,
614
def _emit_progress_update(self):
615
"""Emit an update to the progress bar."""
616
self.pb.update("Committing", self.pb_count, self.pb_total)
619
def _report_deletes(self):
620
for path, ie in self.basis_inv.iter_entries():
621
if ie.file_id not in self.builder.new_inventory:
622
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
