49
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
50
# the rest of the code; add a deprecation of the old name.
57
from cStringIO import StringIO
59
52
from bzrlib import (
65
59
from bzrlib.branch import Branch
60
from bzrlib.cleanup import OperationWithCleanups
66
61
import bzrlib.config
67
62
from bzrlib.errors import (BzrError, PointlessCommit,
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
72
is_inside_or_parent_of_any,
73
quotefn, sha_file, split_lines)
74
from bzrlib.testament import Testament
75
from bzrlib.trace import mutter, note, warning
76
from bzrlib.xml5 import serializer_v5
77
from bzrlib.inventory import Inventory, InventoryEntry
66
from bzrlib.osutils import (get_user_encoding,
68
minimum_path_selection,
71
from bzrlib.trace import mutter, note, is_quiet
72
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
78
73
from bzrlib import symbol_versioning
79
from bzrlib.symbol_versioning import (deprecated_passed,
82
from bzrlib.workingtree import WorkingTree
74
from bzrlib.urlutils import unescape_for_display
86
78
class NullCommitReporter(object):
87
79
"""I report on progress of a commit."""
81
def started(self, revno, revid, location=None):
83
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
84
"to started.", DeprecationWarning,
89
88
def snapshot_change(self, change, path):
92
91
def completed(self, revno, rev_id):
95
def deleted(self, file_id):
98
def escaped(self, escape_count, message):
94
def deleted(self, path):
101
97
def missing(self, path):
115
114
note(format, *args)
117
116
def snapshot_change(self, change, path):
118
if change == 'unchanged':
120
if change == 'added' and path == '':
117
if path == '' and change in ('added', 'modified'):
122
119
self._note("%s %s", change, path)
121
def started(self, revno, rev_id, location=None):
122
if location is not None:
123
location = ' to: ' + unescape_for_display(location, 'utf-8')
125
# When started was added, location was only made optional by
126
# accident. Matt Nordhoff 20071129
127
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
128
"to started.", DeprecationWarning,
131
self._note('Committing%s', location)
124
133
def completed(self, revno, rev_id):
125
134
self._note('Committed revision %d.', revno)
127
def deleted(self, file_id):
128
self._note('deleted %s', file_id)
135
# self._note goes to the console too; so while we want to log the
136
# rev_id, we can't trivially only log it. (See bug 526425). Long
137
# term we should rearrange the reporting structure, but for now
138
# we just mutter seperately. We mutter the revid and revno together
139
# so that concurrent bzr invocations won't lead to confusion.
140
mutter('Committed revid %s as revno %d.', rev_id, revno)
130
def escaped(self, escape_count, message):
131
self._note("replaced %d control characters in message", escape_count)
142
def deleted(self, path):
143
self._note('deleted %s', path)
133
145
def missing(self, path):
134
146
self._note('missing %s', path)
199
219
:param revprops: Properties for new revision
200
220
: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
201
223
:param recursive: If set to 'down', commit in any subtrees that have
202
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):
204
255
mutter('preparing to commit')
206
257
if working_tree is None:
214
265
if message_callback is None:
215
266
if message is not None:
216
267
if isinstance(message, str):
217
message = message.decode(bzrlib.user_encoding)
268
message = message.decode(get_user_encoding())
218
269
message_callback = lambda x: message
220
271
raise BzrError("The message or message_callback keyword"
221
272
" parameter is required for commit().")
223
274
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))
224
281
self.local = local
225
282
self.master_branch = None
226
self.master_locked = False
283
self.recursive = recursive
227
284
self.rev_id = None
228
self.specific_files = specific_files
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
229
293
self.allow_pointless = allow_pointless
230
self.recursive = recursive
231
self.revprops = revprops
232
294
self.message_callback = message_callback
233
295
self.timestamp = timestamp
234
296
self.timezone = timezone
236
298
self.strict = strict
237
299
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
244
301
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))
245
312
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()
246
315
self.basis_tree = self.work_tree.basis_tree()
247
316
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)
249
# Cannot commit with conflicts present.
250
if len(self.work_tree.conflicts()) > 0:
251
raise ConflictsInTree
253
# Setup the bound branch variables as needed.
254
self._check_bound_branch()
256
# Check that the working tree is up to date
257
old_revno,new_revno = self._check_out_of_date_tree()
259
if self.config is None:
260
self.config = self.branch.get_config()
262
# If provided, ensure the specified files are versioned
263
if specific_files is not None:
264
# Note: We don't actually need the IDs here. This routine
265
# is being called because it raises PathNotVerisonedError
266
# as a side effect of finding the IDs.
267
# XXX: Dont we have filter_unversioned to do this more
269
tree.find_ids_across_trees(specific_files,
270
[self.basis_tree, self.work_tree])
272
# Setup the progress bar. As the number of files that need to be
273
# committed in unknown, progress is reported as stages.
274
# We keep track of entries separately though and include that
275
# information in the progress bar during the relevant stages.
276
self.pb_stage_name = ""
277
self.pb_stage_count = 0
278
self.pb_stage_total = 4
368
self.builder.will_record_deletes()
369
# find the location being committed to
279
370
if self.bound_branch:
280
self.pb_stage_total += 1
281
self.pb.show_pct = False
282
self.pb.show_spinner = False
283
self.pb.show_eta = False
284
self.pb.show_count = True
285
self.pb.show_bar = True
287
# After a merge, a selected file commit is not supported.
288
# See 'bzr help merge' for an explanation as to why.
289
self.basis_inv = self.basis_tree.inventory
290
self._gather_parents()
291
if len(self.parents) > 1 and self.specific_files:
292
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
294
# Collect the changes
295
self._set_progress_stage("Collecting changes",
296
entries_title="Directory")
297
self.builder = self.branch.get_commit_builder(self.parents,
298
self.config, timestamp, timezone, committer, revprops, rev_id)
371
master_location = self.master_branch.base
373
master_location = self.branch.base
375
# report the start of the commit
376
self.reporter.started(new_revno, self.rev_id, master_location)
299
378
self._update_builder_with_changes()
300
379
self._check_pointless()
309
388
# Prompt the user for a commit message if none provided
310
389
message = message_callback(self)
311
assert isinstance(message, unicode), type(message)
312
390
self.message = message
313
self._escape_commit_message()
315
392
# Add revision data to the local branch
316
393
self.rev_id = self.builder.commit(self.message)
318
# Upload revision data to the master.
319
# this will propagate merged revisions too if needed.
320
if self.bound_branch:
321
self._set_progress_stage("Uploading data to master branch")
322
self.master_branch.repository.fetch(self.branch.repository,
323
revision_id=self.rev_id)
324
# now the master has the revision data
325
# 'commit' to the master first so a timeout here causes the
326
# local branch to be out of date
327
self.master_branch.set_last_revision_info(new_revno,
330
# and now do the commit locally.
331
self.branch.set_last_revision_info(new_revno, self.rev_id)
333
# Make the working tree up to date with the branch
334
self._set_progress_stage("Updating the working tree")
335
rev_tree = self.builder.revision_tree()
336
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
337
self.reporter.completed(new_revno, self.rev_id)
338
self._process_hooks(old_revno, new_revno)
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)
341
425
return self.rev_id
343
def _any_real_changes(self):
344
"""Are there real changes between new_inventory and basis?
346
For trees without rich roots, inv.root.revision changes every commit.
347
But if that is the only change, we want to treat it as though there
350
new_entries = self.builder.new_inventory.iter_entries()
351
basis_entries = self.basis_inv.iter_entries()
352
new_path, new_root_ie = new_entries.next()
353
basis_path, basis_root_ie = basis_entries.next()
355
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
356
def ie_equal_no_revision(this, other):
357
return ((this.file_id == other.file_id)
358
and (this.name == other.name)
359
and (this.symlink_target == other.symlink_target)
360
and (this.text_sha1 == other.text_sha1)
361
and (this.text_size == other.text_size)
362
and (this.text_id == other.text_id)
363
and (this.parent_id == other.parent_id)
364
and (this.kind == other.kind)
365
and (this.executable == other.executable)
366
and (this.reference_revision == other.reference_revision)
368
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
371
for new_ie, basis_ie in zip(new_entries, basis_entries):
372
if new_ie != basis_ie:
375
# No actual changes present
427
def _select_reporter(self):
428
"""Select the CommitReporter to use."""
430
return NullCommitReporter()
431
return ReportCommitToLog()
378
433
def _check_pointless(self):
379
434
if self.allow_pointless:
381
436
# A merge with no effect on files
382
437
if len(self.parents) > 1:
384
# work around the fact that a newly-initted tree does differ from its
386
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
439
# TODO: we could simplify this by using self.builder.basis_delta.
441
# The initial commit adds a root directory, but this in itself is not
442
# a worthwhile commit.
443
if (self.basis_revid == revision.NULL_REVISION and
444
((self.builder.new_inventory is not None and
445
len(self.builder.new_inventory) == 1) or
446
len(self.builder._basis_delta) == 1)):
387
447
raise PointlessCommit()
388
# Shortcut, if the number of entries changes, then we obviously have
390
if len(self.builder.new_inventory) != len(self.basis_inv):
392
# If length == 1, then we only have the root entry. Which means
393
# that there is no real difference (only the root could be different)
394
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
448
if self.builder.any_changes():
396
450
raise PointlessCommit()
398
def _check_bound_branch(self):
452
def _check_bound_branch(self, operation, possible_master_transports=None):
399
453
"""Check to see if the local branch is bound.
401
455
If it is bound, then most of the commit will actually be
489
556
old_revid = self.parents[0]
491
558
old_revid = bzrlib.revision.NULL_REVISION
492
for hook in Branch.hooks['post_commit']:
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]:
493
566
# show the running hook in the progress bar. As hooks may
494
567
# end up doing nothing (e.g. because they are not configured by
495
568
# the user) this is still showing progress, not showing overall
496
569
# actions - its up to each plugin to show a UI if it want's to
497
570
# (such as 'Emailing diff to foo@example.com').
498
self.pb_stage_name = "Running post commit hooks [%s]" % \
499
Branch.hooks.get_hook_name(hook)
571
self.pb_stage_name = "Running %s hooks [%s]" % \
572
(hook_name, Branch.hooks.get_hook_name(hook))
500
573
self._emit_progress()
501
574
if 'hooks' in debug.debug_flags:
502
575
mutter("Invoking commit hook: %r", hook)
503
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
507
"""Cleanup any open locks, progress bars etc."""
508
cleanups = [self._cleanup_bound_branch,
509
self.basis_tree.unlock,
510
self.work_tree.unlock,
512
found_exception = None
513
for cleanup in cleanups:
516
# we want every cleanup to run no matter what.
517
# so we have a catchall here, but we will raise the
518
# last encountered exception up the stack: and
519
# typically this will be useful enough.
522
if found_exception is not None:
523
# don't do a plan raise, because the last exception may have been
524
# trashed, e is our sure-to-work exception even though it loses the
525
# full traceback. XXX: RBC 20060421 perhaps we could check the
526
# exc_info and if its the same one do a plain raise otherwise
527
# 'raise e' as we do now.
530
def _cleanup_bound_branch(self):
531
"""Executed at the end of a try/finally to cleanup a bound branch.
533
If the branch wasn't bound, this is a no-op.
534
If it was, it resents self.branch to the local branch, instead
537
if not self.bound_branch:
539
if self.master_locked:
540
self.master_branch.unlock()
542
def _escape_commit_message(self):
543
"""Replace xml-incompatible control characters."""
544
# FIXME: RBC 20060419 this should be done by the revision
545
# serialiser not by commit. Then we can also add an unescaper
546
# in the deserializer and start roundtripping revision messages
547
# precisely. See repository_implementations/test_repository.py
549
# Python strings can include characters that can't be
550
# represented in well-formed XML; escape characters that
551
# aren't listed in the XML specification
552
# (http://www.w3.org/TR/REC-xml/#NT-Char).
553
self.message, escape_count = re.subn(
554
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
555
lambda match: match.group(0).encode('unicode_escape'),
558
self.reporter.escaped(escape_count, self.message)
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)
560
584
def _gather_parents(self):
561
585
"""Record the parents of a merge for merge detection."""
562
# TODO: Make sure that this list doesn't contain duplicate
586
# TODO: Make sure that this list doesn't contain duplicate
563
587
# entries and the order is preserved when doing this.
564
self.parents = self.work_tree.get_parent_ids()
588
if self.use_record_iter_changes:
590
self.basis_inv = self.basis_tree.inventory
565
591
self.parent_invs = [self.basis_inv]
566
592
for revision in self.parents[1:]:
567
593
if self.branch.repository.has_revision(revision):
574
600
def _update_builder_with_changes(self):
575
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()
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."""
577
732
# Build the revision inventory.
579
734
# This starts by creating a new empty inventory. Depending on
580
735
# which files are selected for commit, and what is present in the
581
# current tree, the new inventory is populated. inventory entries
736
# current tree, the new inventory is populated. inventory entries
582
737
# which are candidates for modification have their revision set to
583
738
# None; inventory entries that are carried over untouched have their
584
739
# revision set to their prior value.
589
744
# ADHB 11-07-2006
591
746
specific_files = self.specific_files
592
mutter("Selecting files for commit with filter %s", specific_files)
594
# Check and warn about old CommitBuilders
595
if not self.builder.record_root_entry:
596
symbol_versioning.warn('CommitBuilders should support recording'
597
' the root entry as of bzr 0.10.', DeprecationWarning,
599
self.builder.new_inventory.add(self.basis_inv.root.copy())
601
# Build the new inventory
602
self._populate_from_inventory(specific_files)
604
# If specific files are selected, then all un-selected files must be
605
# recorded in their previous state. For more details, see
606
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
608
for path, new_ie in self.basis_inv.iter_entries():
609
if new_ie.file_id in self.builder.new_inventory:
611
if is_inside_any(specific_files, path):
615
self.builder.record_entry_contents(ie, self.parent_invs, path,
618
# Report what was deleted. We could skip this when no deletes are
619
# detected to gain a performance win, but it arguably serves as a
620
# 'safety check' by informing the user whenever anything disappears.
621
for path, ie in self.basis_inv.iter_entries():
622
if ie.file_id not in self.builder.new_inventory:
623
self.reporter.deleted(path)
625
def _populate_from_inventory(self, specific_files):
626
"""Populate the CommitBuilder by walking the working tree inventory."""
628
# raise an exception as soon as we find a single unknown.
629
for unknown in self.work_tree.unknowns():
630
raise StrictCommitFailed()
747
exclude = self.exclude
748
report_changes = self.reporter.is_verbose()
633
deleted_paths = set()
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.
634
755
work_inv = self.work_tree.inventory
635
assert work_inv.root is not None
636
entries = work_inv.iter_entries()
637
if not self.builder.record_root_entry:
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)
639
760
for path, existing_ie in entries:
640
761
file_id = existing_ie.file_id
641
762
name = existing_ie.name
642
763
parent_id = existing_ie.parent_id
643
764
kind = existing_ie.kind
644
if kind == 'directory':
645
self._next_progress_entry()
647
765
# Skip files that have been deleted from the working tree.
648
# The deleted files/directories are also recorded so they
649
# can be explicitly unversioned later. Note that when a
650
# filter of specific files is given, we must only skip/record
651
# deleted files matching that filter.
652
if is_inside_any(deleted_paths, path):
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.
654
791
if not specific_files or is_inside_any(specific_files, path):
655
if not self.work_tree.has_filename(path):
656
deleted_paths.add(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, {})
657
799
self.reporter.missing(path)
800
self._next_progress_entry()
658
801
deleted_ids.append(file_id)
661
kind = self.work_tree.kind(file_id)
662
# TODO: specific_files filtering before nested tree processing
663
if kind == 'tree-reference' and self.recursive == 'down':
664
self._commit_nested_tree(file_id, path)
665
except errors.NoSuchFile:
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)
668
820
# Record an entry for this item
669
821
# Note: I don't particularly want to have the existing_ie
670
822
# parameter but the test suite currently (28-Jun-07) breaks
671
823
# without it thanks to a unicode normalisation issue. :-(
672
definitely_changed = kind != existing_ie.kind
824
definitely_changed = kind != existing_ie.kind
673
825
self._record_entry(path, file_id, specific_files, kind, name,
674
parent_id, definitely_changed, existing_ie)
826
parent_id, definitely_changed, existing_ie, report_changes,
676
829
# Unversion IDs that were found to be deleted
677
self.work_tree.unversion(deleted_ids)
830
self.deleted_ids = deleted_ids
679
832
def _commit_nested_tree(self, file_id, path):
680
833
"Commit a nested tree."
700
852
strict=self.strict, verbose=self.verbose,
701
853
local=self.local, reporter=self.reporter)
702
854
except errors.PointlessCommit:
855
return self.work_tree.get_reference_revision(file_id)
705
857
def _record_entry(self, path, file_id, specific_files, kind, name,
706
parent_id, definitely_changed, existing_ie=None):
858
parent_id, definitely_changed, existing_ie, report_changes,
707
860
"Record the new inventory entry for a path if any."
708
861
# mutter('check %s {%s}', path, file_id)
709
if (not specific_files or
710
is_inside_or_parent_of_any(specific_files, path)):
711
# mutter('%s selected for commit', path)
712
if definitely_changed or existing_ie is None:
713
ie = inventory.make_entry(kind, name, parent_id, file_id)
715
ie = existing_ie.copy()
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)
718
# mutter('%s not selected for commit', path)
719
if self.basis_inv.has_id(file_id):
720
ie = self.basis_inv[file_id].copy()
722
# this entry is new and not being committed
725
self.builder.record_entry_contents(ie, self.parent_invs,
726
path, self.work_tree)
866
ie = existing_ie.copy()
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)
727
873
self._report_change(ie, path)
875
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
730
878
def _report_change(self, ie, path):
740
888
change = ie.describe_change(basis_ie, ie)
741
if change in (InventoryEntry.RENAMED,
889
if change in (InventoryEntry.RENAMED,
742
890
InventoryEntry.MODIFIED_AND_RENAMED):
743
891
old_path = self.basis_inv.id2path(ie.file_id)
744
892
self.reporter.renamed(change, old_path, path)
893
self._next_progress_entry()
895
if change == 'unchanged':
746
897
self.reporter.snapshot_change(change, path)
898
self._next_progress_entry()
748
def _set_progress_stage(self, name, entries_title=None):
900
def _set_progress_stage(self, name, counter=False):
749
901
"""Set the progress stage and emit an update to the progress bar."""
750
902
self.pb_stage_name = name
751
903
self.pb_stage_count += 1
752
self.pb_entries_title = entries_title
753
if entries_title is not None:
754
905
self.pb_entries_count = 0
755
self.pb_entries_total = '?'
907
self.pb_entries_count = None
756
908
self._emit_progress()
758
910
def _next_progress_entry(self):
761
913
self._emit_progress()
763
915
def _emit_progress(self):
764
if self.pb_entries_title:
765
if self.pb_entries_total == '?':
766
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
767
self.pb_entries_title, self.pb_entries_count)
769
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
770
self.pb_entries_title, self.pb_entries_count,
771
str(self.pb_entries_total))
916
if self.pb_entries_count is not None:
917
text = "%s [%d] - Stage" % (self.pb_stage_name,
918
self.pb_entries_count)
773
text = "%s - Stage" % (self.pb_stage_name)
920
text = "%s - Stage" % (self.pb_stage_name, )
774
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
added
removed
bzrlib/commit.py
