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