49
50
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
51
# the rest of the code; add a deprecation of the old name.
57
from cStringIO import StringIO
59
53
from bzrlib import (
65
60
from bzrlib.branch import Branch
61
from bzrlib.cleanup import OperationWithCleanups
66
62
import bzrlib.config
67
63
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
67
from bzrlib.osutils import (get_user_encoding,
69
minimum_path_selection,
72
from bzrlib.trace import mutter, note, is_quiet
73
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
78
74
from bzrlib import symbol_versioning
79
from bzrlib.symbol_versioning import (deprecated_passed,
82
from bzrlib.workingtree import WorkingTree
75
from bzrlib.urlutils import unescape_for_display
76
from bzrlib.i18n import gettext
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 (gettext('added'), gettext('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(gettext('Committing%s'), location)
124
133
def completed(self, revno, rev_id):
125
self._note('Committed revision %d.', revno)
127
def deleted(self, file_id):
128
self._note('deleted %s', file_id)
134
self._note(gettext('Committed revision %d.'), revno)
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(gettext('deleted %s'), path)
133
145
def missing(self, path):
134
self._note('missing %s', path)
146
self._note(gettext('missing %s'), path)
136
148
def renamed(self, change, old_path, new_path):
137
149
self._note('%s %s => %s', change, old_path, new_path)
151
def is_verbose(self):
140
155
class Commit(object):
141
156
"""Task of committing a new revision.
152
167
def __init__(self,
155
if reporter is not None:
156
self.reporter = reporter
158
self.reporter = NullCommitReporter()
170
"""Create a Commit object.
172
:param reporter: the default reporter to use or None to decide later
174
self.reporter = reporter
175
self.config_stack = config_stack
178
def update_revprops(revprops, branch, authors=None, author=None,
179
local=False, possible_master_transports=None):
182
if possible_master_transports is None:
183
possible_master_transports = []
184
if not 'branch-nick' in revprops:
185
revprops['branch-nick'] = branch._get_nick(
187
possible_master_transports)
188
if authors is not None:
189
if author is not None:
190
raise AssertionError('Specifying both author and authors '
191
'is not allowed. Specify just authors instead')
192
if 'author' in revprops or 'authors' in revprops:
193
# XXX: maybe we should just accept one of them?
194
raise AssertionError('author property given twice')
196
for individual in authors:
197
if '\n' in individual:
198
raise AssertionError('\\n is not a valid character '
199
'in an author identity')
200
revprops['authors'] = '\n'.join(authors)
201
if author is not None:
202
symbol_versioning.warn('The parameter author was deprecated'
203
' in version 1.13. Use authors instead',
205
if 'author' in revprops or 'authors' in revprops:
206
# XXX: maybe we should just accept one of them?
207
raise AssertionError('author property given twice')
209
raise AssertionError('\\n is not a valid character '
210
'in an author identity')
211
revprops['authors'] = author
199
257
:param revprops: Properties for new revision
200
258
:param local: Perform a local only commit.
259
:param reporter: the reporter to use or None for the default
260
:param verbose: if True and the reporter is not None, report everything
201
261
:param recursive: If set to 'down', commit in any subtrees that have
202
262
pending changes of any sort during this commit.
263
:param exclude: None or a list of relative paths to exclude from the
264
commit. Pending changes to excluded files will be ignored by the
266
:param lossy: When committing to a foreign VCS, ignore any
267
data that can not be natively represented.
269
operation = OperationWithCleanups(self._commit)
270
self.revprops = revprops or {}
271
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
272
self.config_stack = config or self.config_stack
273
return operation.run(
278
specific_files=specific_files,
280
allow_pointless=allow_pointless,
283
working_tree=working_tree,
286
message_callback=message_callback,
289
possible_master_transports=possible_master_transports,
292
def _commit(self, operation, message, timestamp, timezone, committer,
293
specific_files, rev_id, allow_pointless, strict, verbose,
294
working_tree, local, reporter, message_callback, recursive,
295
exclude, possible_master_transports, lossy):
204
296
mutter('preparing to commit')
206
298
if working_tree is None:
214
306
if message_callback is None:
215
307
if message is not None:
216
308
if isinstance(message, str):
217
message = message.decode(bzrlib.user_encoding)
309
message = message.decode(get_user_encoding())
218
310
message_callback = lambda x: message
220
312
raise BzrError("The message or message_callback keyword"
221
313
" parameter is required for commit().")
223
315
self.bound_branch = None
316
self.any_entries_deleted = False
317
if exclude is not None:
318
self.exclude = sorted(
319
minimum_path_selection(exclude))
224
322
self.local = local
225
323
self.master_branch = None
226
self.master_locked = False
324
self.recursive = recursive
227
325
self.rev_id = None
228
self.specific_files = specific_files
326
# self.specific_files is None to indicate no filter, or any iterable to
327
# indicate a filter - [] means no files at all, as per iter_changes.
328
if specific_files is not None:
329
self.specific_files = sorted(
330
minimum_path_selection(specific_files))
332
self.specific_files = None
229
334
self.allow_pointless = allow_pointless
230
self.recursive = recursive
231
self.revprops = revprops
232
335
self.message_callback = message_callback
233
336
self.timestamp = timestamp
234
337
self.timezone = timezone
236
339
self.strict = strict
237
340
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
342
self.work_tree.lock_write()
245
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
343
operation.add_cleanup(self.work_tree.unlock)
344
self.parents = self.work_tree.get_parent_ids()
345
# We can use record_iter_changes IFF iter_changes is compatible with
346
# the command line parameters, and the repository has fast delta
347
# generation. See bug 347649.
348
self.use_record_iter_changes = (
350
not self.branch.repository._format.supports_tree_reference and
351
(self.branch.repository._format.fast_deltas or
352
len(self.parents) < 2))
353
self.pb = ui.ui_factory.nested_progress_bar()
354
operation.add_cleanup(self.pb.finished)
355
self.basis_revid = self.work_tree.last_revision()
246
356
self.basis_tree = self.work_tree.basis_tree()
247
357
self.basis_tree.lock_read()
358
operation.add_cleanup(self.basis_tree.unlock)
359
# Cannot commit with conflicts present.
360
if len(self.work_tree.conflicts()) > 0:
361
raise ConflictsInTree
363
# Setup the bound branch variables as needed.
364
self._check_bound_branch(operation, possible_master_transports)
366
# Check that the working tree is up to date
367
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
369
# Complete configuration setup
370
if reporter is not None:
371
self.reporter = reporter
372
elif self.reporter is None:
373
self.reporter = self._select_reporter()
374
if self.config_stack is None:
375
self.config_stack = self.work_tree.get_config_stack()
377
self._set_specific_file_ids()
379
# Setup the progress bar. As the number of files that need to be
380
# committed in unknown, progress is reported as stages.
381
# We keep track of entries separately though and include that
382
# information in the progress bar during the relevant stages.
383
self.pb_stage_name = ""
384
self.pb_stage_count = 0
385
self.pb_stage_total = 5
386
if self.bound_branch:
387
# 2 extra stages: "Uploading data to master branch" and "Merging
388
# tags to master branch"
389
self.pb_stage_total += 2
390
self.pb.show_pct = False
391
self.pb.show_spinner = False
392
self.pb.show_eta = False
393
self.pb.show_count = True
394
self.pb.show_bar = True
396
self._gather_parents()
397
# After a merge, a selected file commit is not supported.
398
# See 'bzr help merge' for an explanation as to why.
399
if len(self.parents) > 1 and self.specific_files is not None:
400
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
401
# Excludes are a form of selected file commit.
402
if len(self.parents) > 1 and self.exclude:
403
raise errors.CannotCommitSelectedFileMerge(self.exclude)
405
# Collect the changes
406
self._set_progress_stage("Collecting changes", counter=True)
408
self.builder = self.branch.get_commit_builder(self.parents,
409
self.config_stack, timestamp, timezone, committer, self.revprops,
411
if not self.builder.supports_record_entry_contents and self.exclude:
413
raise errors.ExcludesUnsupported(self.branch.repository)
415
if self.builder.updates_branch and self.bound_branch:
417
raise AssertionError(
418
"bound branches not supported for commit builders "
419
"that update the branch")
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
422
self.builder.will_record_deletes()
423
# find the location being committed to
279
424
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)
425
master_location = self.master_branch.base
427
master_location = self.branch.base
429
# report the start of the commit
430
self.reporter.started(new_revno, self.rev_id, master_location)
299
432
self._update_builder_with_changes()
300
433
self._check_pointless()
309
442
# Prompt the user for a commit message if none provided
310
443
message = message_callback(self)
311
assert isinstance(message, unicode), type(message)
312
444
self.message = message
313
self._escape_commit_message()
315
446
# Add revision data to the local branch
316
447
self.rev_id = self.builder.commit(self.message)
450
mutter("aborting commit write group because of exception:")
451
trace.log_exception_quietly()
455
self._update_branches(old_revno, old_revid, new_revno)
457
# Make the working tree be up to date with the branch. This
458
# includes automatic changes scheduled to be made to the tree, such
459
# as updating its basis and unversioning paths that were missing.
460
self.work_tree.unversion(self.deleted_ids)
461
self._set_progress_stage("Updating the working tree")
462
self.work_tree.update_basis_by_delta(self.rev_id,
463
self.builder.get_basis_delta())
464
self.reporter.completed(new_revno, self.rev_id)
465
self._process_post_hooks(old_revno, new_revno)
468
def _update_branches(self, old_revno, old_revid, new_revno):
469
"""Update the master and local branch to the new revision.
471
This will try to make sure that the master branch is updated
472
before the local branch.
474
:param old_revno: Revision number of master branch before the
476
:param old_revid: Tip of master branch before the commit
477
:param new_revno: Revision number of the new commit
479
if not self.builder.updates_branch:
480
self._process_pre_hooks(old_revno, new_revno)
318
482
# Upload revision data to the master.
319
483
# this will propagate merged revisions too if needed.
320
484
if self.bound_branch:
321
485
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
486
# 'commit' to the master first so a timeout here causes the
326
487
# local branch to be out of date
327
self.master_branch.set_last_revision_info(new_revno,
488
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
489
self.branch, new_revno, self.rev_id, lossy=self._lossy)
491
self.branch.fetch(self.master_branch, self.rev_id)
330
493
# and now do the commit locally.
331
494
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)
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
497
self._process_pre_hooks(old_revno, new_revno)
499
# The commit builder will already have updated the branch,
501
self.branch.set_last_revision_info(old_revno, old_revid)
504
# Merge local tags to remote
505
if self.bound_branch:
506
self._set_progress_stage("Merging tags to master branch")
507
tag_updates, tag_conflicts = self.branch.tags.merge_to(
508
self.master_branch.tags)
510
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
511
note( gettext("Conflicting tags in bound branch:\n{0}".format(
512
"\n".join(warning_lines))) )
514
def _select_reporter(self):
515
"""Select the CommitReporter to use."""
517
return NullCommitReporter()
518
return ReportCommitToLog()
378
520
def _check_pointless(self):
379
521
if self.allow_pointless:
460
594
# ghost parents never appear in revision history.
462
return old_revno,new_revno
464
def _process_hooks(self, old_revno, new_revno):
465
"""Process any registered commit hooks."""
596
return old_revno, master_last, new_revno
598
def _process_pre_hooks(self, old_revno, new_revno):
599
"""Process any registered pre commit hooks."""
600
self._set_progress_stage("Running pre_commit hooks")
601
self._process_hooks("pre_commit", old_revno, new_revno)
603
def _process_post_hooks(self, old_revno, new_revno):
604
"""Process any registered post commit hooks."""
466
605
# Process the post commit hooks, if any
467
self._set_progress_stage("Running post commit hooks")
606
self._set_progress_stage("Running post_commit hooks")
468
607
# old style commit hooks - should be deprecated ? (obsoleted in
470
if self.config.post_commit() is not None:
471
hooks = self.config.post_commit().split(' ')
608
# 0.15^H^H^H^H 2.5.0)
609
post_commit = self.config_stack.get('post_commit')
610
if post_commit is not None:
611
hooks = post_commit.split(' ')
472
612
# this would be nicer with twisted.python.reflect.namedAny
473
613
for hook in hooks:
474
614
result = eval(hook + '(branch, rev_id)',
475
615
{'branch':self.branch,
477
617
'rev_id':self.rev_id})
618
# process new style post commit hooks
619
self._process_hooks("post_commit", old_revno, new_revno)
621
def _process_hooks(self, hook_name, old_revno, new_revno):
622
if not Branch.hooks[hook_name]:
478
625
# new style commit hooks:
479
626
if not self.bound_branch:
480
627
hook_master = self.branch
489
636
old_revid = self.parents[0]
491
638
old_revid = bzrlib.revision.NULL_REVISION
492
for hook in Branch.hooks['post_commit']:
640
if hook_name == "pre_commit":
641
future_tree = self.builder.revision_tree()
642
tree_delta = future_tree.changes_from(self.basis_tree,
645
for hook in Branch.hooks[hook_name]:
493
646
# show the running hook in the progress bar. As hooks may
494
647
# end up doing nothing (e.g. because they are not configured by
495
648
# the user) this is still showing progress, not showing overall
496
649
# actions - its up to each plugin to show a UI if it want's to
497
650
# (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)
651
self.pb_stage_name = "Running %s hooks [%s]" % \
652
(hook_name, Branch.hooks.get_hook_name(hook))
500
653
self._emit_progress()
501
654
if 'hooks' in debug.debug_flags:
502
655
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)
656
if hook_name == "post_commit":
657
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
659
elif hook_name == "pre_commit":
660
hook(hook_local, hook_master,
661
old_revno, old_revid, new_revno, self.rev_id,
662
tree_delta, future_tree)
560
664
def _gather_parents(self):
561
665
"""Record the parents of a merge for merge detection."""
562
# TODO: Make sure that this list doesn't contain duplicate
666
# TODO: Make sure that this list doesn't contain duplicate
563
667
# entries and the order is preserved when doing this.
564
self.parents = self.work_tree.get_parent_ids()
668
if self.use_record_iter_changes:
670
self.basis_inv = self.basis_tree.root_inventory
565
671
self.parent_invs = [self.basis_inv]
566
672
for revision in self.parents[1:]:
567
673
if self.branch.repository.has_revision(revision):
574
680
def _update_builder_with_changes(self):
575
681
"""Update the commit builder with the data about what has changed.
683
exclude = self.exclude
684
specific_files = self.specific_files
685
mutter("Selecting files for commit with filter %s", specific_files)
688
if self.use_record_iter_changes:
689
iter_changes = self.work_tree.iter_changes(self.basis_tree,
690
specific_files=specific_files)
691
iter_changes = self._filter_iter_changes(iter_changes)
692
for file_id, path, fs_hash in self.builder.record_iter_changes(
693
self.work_tree, self.basis_revid, iter_changes):
694
self.work_tree._observed_sha1(file_id, path, fs_hash)
696
# Build the new inventory
697
self._populate_from_inventory()
698
self._record_unselected()
699
self._report_and_accumulate_deletes()
701
def _filter_iter_changes(self, iter_changes):
702
"""Process iter_changes.
704
This method reports on the changes in iter_changes to the user, and
705
converts 'missing' entries in the iter_changes iterator to 'deleted'
706
entries. 'missing' entries have their
708
:param iter_changes: An iter_changes to process.
709
:return: A generator of changes.
711
reporter = self.reporter
712
report_changes = reporter.is_verbose()
714
for change in iter_changes:
716
old_path = change[1][0]
717
new_path = change[1][1]
718
versioned = change[3][1]
720
versioned = change[3][1]
721
if kind is None and versioned:
724
reporter.missing(new_path)
725
deleted_ids.append(change[0])
726
# Reset the new path (None) and new versioned flag (False)
727
change = (change[0], (change[1][0], None), change[2],
728
(change[3][0], False)) + change[4:]
729
new_path = change[1][1]
731
elif kind == 'tree-reference':
732
if self.recursive == 'down':
733
self._commit_nested_tree(change[0], change[1][1])
734
if change[3][0] or change[3][1]:
738
reporter.deleted(old_path)
739
elif old_path is None:
740
reporter.snapshot_change(gettext('added'), new_path)
741
elif old_path != new_path:
742
reporter.renamed(gettext('renamed'), old_path, new_path)
745
self.work_tree.branch.repository._format.rich_root_data):
746
# Don't report on changes to '' in non rich root
748
reporter.snapshot_change(gettext('modified'), new_path)
749
self._next_progress_entry()
750
# Unversion IDs that were found to be deleted
751
self.deleted_ids = deleted_ids
753
def _record_unselected(self):
754
# If specific files are selected, then all un-selected files must be
755
# recorded in their previous state. For more details, see
756
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
757
if self.specific_files or self.exclude:
758
specific_files = self.specific_files or []
759
for path, old_ie in self.basis_inv.iter_entries():
760
if self.builder.new_inventory.has_id(old_ie.file_id):
761
# already added - skip.
763
if (is_inside_any(specific_files, path)
764
and not is_inside_any(self.exclude, path)):
765
# was inside the selected path, and not excluded - if not
766
# present it has been deleted so skip.
768
# From here down it was either not selected, or was excluded:
769
# We preserve the entry unaltered.
771
# Note: specific file commits after a merge are currently
772
# prohibited. This test is for sanity/safety in case it's
773
# required after that changes.
774
if len(self.parents) > 1:
776
self.builder.record_entry_contents(ie, self.parent_invs, path,
777
self.basis_tree, None)
779
def _report_and_accumulate_deletes(self):
780
if (isinstance(self.basis_inv, Inventory)
781
and isinstance(self.builder.new_inventory, Inventory)):
782
# the older Inventory classes provide a _byid dict, and building a
783
# set from the keys of this dict is substantially faster than even
784
# getting a set of ids from the inventory
786
# <lifeless> set(dict) is roughly the same speed as
787
# set(iter(dict)) and both are significantly slower than
789
deleted_ids = set(self.basis_inv._byid.keys()) - \
790
set(self.builder.new_inventory._byid.keys())
792
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
794
self.any_entries_deleted = True
795
deleted = [(self.basis_tree.id2path(file_id), file_id)
796
for file_id in deleted_ids]
798
# XXX: this is not quite directory-order sorting
799
for path, file_id in deleted:
800
self.builder.record_delete(path, file_id)
801
self.reporter.deleted(path)
803
def _check_strict(self):
804
# XXX: when we use iter_changes this would likely be faster if
805
# iter_changes would check for us (even in the presence of
808
# raise an exception as soon as we find a single unknown.
809
for unknown in self.work_tree.unknowns():
810
raise StrictCommitFailed()
812
def _populate_from_inventory(self):
813
"""Populate the CommitBuilder by walking the working tree inventory."""
577
814
# Build the revision inventory.
579
816
# This starts by creating a new empty inventory. Depending on
580
817
# which files are selected for commit, and what is present in the
581
# current tree, the new inventory is populated. inventory entries
818
# current tree, the new inventory is populated. inventory entries
582
819
# which are candidates for modification have their revision set to
583
820
# None; inventory entries that are carried over untouched have their
584
821
# revision set to their prior value.
589
826
# ADHB 11-07-2006
591
828
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()
829
exclude = self.exclude
830
report_changes = self.reporter.is_verbose()
633
deleted_paths = set()
634
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:
832
# A tree of paths that have been deleted. E.g. if foo/bar has been
833
# deleted, then we have {'foo':{'bar':{}}}
835
# XXX: Note that entries may have the wrong kind because the entry does
836
# not reflect the status on disk.
837
# NB: entries will include entries within the excluded ids/paths
838
# because iter_entries_by_dir has no 'exclude' facility today.
839
entries = self.work_tree.iter_entries_by_dir(
840
specific_file_ids=self.specific_file_ids, yield_parents=True)
639
841
for path, existing_ie in entries:
640
842
file_id = existing_ie.file_id
641
843
name = existing_ie.name
642
844
parent_id = existing_ie.parent_id
643
845
kind = existing_ie.kind
644
if kind == 'directory':
645
self._next_progress_entry()
647
846
# 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):
847
# The deleted path ids are also recorded so they can be explicitly
850
path_segments = splitpath(path)
851
deleted_dict = deleted_paths
852
for segment in path_segments:
853
deleted_dict = deleted_dict.get(segment, None)
855
# We either took a path not present in the dict
856
# (deleted_dict was None), or we've reached an empty
857
# child dir in the dict, so are now a sub-path.
861
if deleted_dict is not None:
862
# the path has a deleted parent, do not add it.
864
if exclude and is_inside_any(exclude, path):
865
# Skip excluded paths. Excluded paths are processed by
866
# _update_builder_with_changes.
868
content_summary = self.work_tree.path_content_summary(path)
869
kind = content_summary[0]
870
# Note that when a filter of specific files is given, we must only
871
# skip/record deleted files matching that filter.
654
872
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)
873
if kind == 'missing':
874
if not deleted_paths:
875
# path won't have been split yet.
876
path_segments = splitpath(path)
877
deleted_dict = deleted_paths
878
for segment in path_segments:
879
deleted_dict = deleted_dict.setdefault(segment, {})
657
880
self.reporter.missing(path)
881
self._next_progress_entry()
658
882
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:
884
# TODO: have the builder do the nested commit just-in-time IF and
886
if kind == 'tree-reference':
887
# enforce repository nested tree policy.
888
if (not self.work_tree.supports_tree_reference() or
889
# repository does not support it either.
890
not self.branch.repository._format.supports_tree_reference):
892
content_summary = (kind, None, None, None)
893
elif self.recursive == 'down':
894
nested_revision_id = self._commit_nested_tree(
896
content_summary = (kind, None, None, nested_revision_id)
898
nested_revision_id = self.work_tree.get_reference_revision(file_id)
899
content_summary = (kind, None, None, nested_revision_id)
668
901
# Record an entry for this item
669
902
# Note: I don't particularly want to have the existing_ie
670
903
# parameter but the test suite currently (28-Jun-07) breaks
671
904
# without it thanks to a unicode normalisation issue. :-(
672
definitely_changed = kind != existing_ie.kind
905
definitely_changed = kind != existing_ie.kind
673
906
self._record_entry(path, file_id, specific_files, kind, name,
674
parent_id, definitely_changed, existing_ie)
907
parent_id, definitely_changed, existing_ie, report_changes,
676
910
# Unversion IDs that were found to be deleted
677
self.work_tree.unversion(deleted_ids)
911
self.deleted_ids = deleted_ids
679
913
def _commit_nested_tree(self, file_id, path):
680
914
"Commit a nested tree."
700
933
strict=self.strict, verbose=self.verbose,
701
934
local=self.local, reporter=self.reporter)
702
935
except errors.PointlessCommit:
936
return self.work_tree.get_reference_revision(file_id)
705
938
def _record_entry(self, path, file_id, specific_files, kind, name,
706
parent_id, definitely_changed, existing_ie=None):
939
parent_id, definitely_changed, existing_ie, report_changes,
707
941
"Record the new inventory entry for a path if any."
708
942
# 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()
943
# mutter('%s selected for commit', path)
944
if definitely_changed or existing_ie is None:
945
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)
947
ie = existing_ie.copy()
949
# For carried over entries we don't care about the fs hash - the repo
950
# isn't generating a sha, so we're not saving computation time.
951
_, _, fs_hash = self.builder.record_entry_contents(
952
ie, self.parent_invs, path, self.work_tree, content_summary)
727
954
self._report_change(ie, path)
956
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
730
959
def _report_change(self, ie, path):
740
969
change = ie.describe_change(basis_ie, ie)
741
if change in (InventoryEntry.RENAMED,
970
if change in (InventoryEntry.RENAMED,
742
971
InventoryEntry.MODIFIED_AND_RENAMED):
743
972
old_path = self.basis_inv.id2path(ie.file_id)
744
973
self.reporter.renamed(change, old_path, path)
974
self._next_progress_entry()
976
if change == gettext('unchanged'):
746
978
self.reporter.snapshot_change(change, path)
979
self._next_progress_entry()
748
def _set_progress_stage(self, name, entries_title=None):
981
def _set_progress_stage(self, name, counter=False):
749
982
"""Set the progress stage and emit an update to the progress bar."""
750
983
self.pb_stage_name = name
751
984
self.pb_stage_count += 1
752
self.pb_entries_title = entries_title
753
if entries_title is not None:
754
986
self.pb_entries_count = 0
755
self.pb_entries_total = '?'
988
self.pb_entries_count = None
756
989
self._emit_progress()
758
991
def _next_progress_entry(self):
761
994
self._emit_progress()
763
996
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))
997
if self.pb_entries_count is not None:
998
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
999
self.pb_entries_count)
773
text = "%s - Stage" % (self.pb_stage_name)
1001
text = gettext("%s - Stage") % (self.pb_stage_name, )
774
1002
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
1004
def _set_specific_file_ids(self):
1005
"""populate self.specific_file_ids if we will use it."""
1006
if not self.use_record_iter_changes:
1007
# If provided, ensure the specified files are versioned
1008
if self.specific_files is not None:
1009
# Note: This routine is being called because it raises
1010
# PathNotVersionedError as a side effect of finding the IDs. We
1011
# later use the ids we found as input to the working tree
1012
# inventory iterator, so we only consider those ids rather than
1013
# examining the whole tree again.
1014
# XXX: Dont we have filter_unversioned to do this more
1016
self.specific_file_ids = tree.find_ids_across_trees(
1017
self.specific_files, [self.basis_tree, self.work_tree])
1019
self.specific_file_ids = None
added
removed
bzrlib/commit.py
