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