108
114
class ReportCommitToLog(NullCommitReporter):
110
def _note(self, format, *args):
113
Subclasses may choose to override this method.
116
# this may be more useful if 'note' was replaced by an overridable
117
# method on self, which would allow more trivial subclassing.
118
# alternative, a callable could be passed in, allowing really trivial
119
# reuse for some uis. RBC 20060511
117
121
def snapshot_change(self, change, path):
118
122
if change == 'unchanged':
120
if change == 'added' and path == '':
122
self._note("%s %s", change, path)
124
note("%s %s", change, path)
124
126
def completed(self, revno, rev_id):
125
self._note('Committed revision %d.', revno)
127
note('Committed revision %d.', revno)
127
129
def deleted(self, file_id):
128
self._note('deleted %s', file_id)
130
note('deleted %s', file_id)
130
132
def escaped(self, escape_count, message):
131
self._note("replaced %d control characters in message", escape_count)
133
note("replaced %d control characters in message", escape_count)
133
135
def missing(self, path):
134
self._note('missing %s', path)
136
note('missing %s', path)
136
138
def renamed(self, change, old_path, new_path):
137
self._note('%s %s => %s', change, old_path, new_path)
139
note('%s %s => %s', change, old_path, new_path)
140
142
class Commit(object):
172
177
working_tree=None,
176
message_callback=None,
178
181
"""Commit working copy as a new revision.
180
:param message: the commit message (it or message_callback is required)
182
:param timestamp: if not None, seconds-since-epoch for a
183
postdated/predated commit.
185
:param specific_files: If true, commit only those files.
187
:param rev_id: If set, use this as the new revision id.
183
branch -- the deprecated branch to commit to. New callers should pass in
186
message -- the commit message, a mandatory parameter
188
timestamp -- if not None, seconds-since-epoch for a
189
postdated/predated commit.
191
specific_files -- If true, commit only those files.
193
rev_id -- If set, use this as the new revision id.
188
194
Useful for test or import commands that need to tightly
189
195
control what revisions are assigned. If you duplicate
190
196
a revision id that exists elsewhere it is your own fault.
191
197
If null (default), a time/random revision id is generated.
193
:param allow_pointless: If true (default), commit even if nothing
199
allow_pointless -- If true (default), commit even if nothing
194
200
has changed and no merges are recorded.
196
:param strict: If true, don't allow a commit if the working tree
202
strict -- If true, don't allow a commit if the working tree
197
203
contains unknown files.
199
:param revprops: Properties for new revision
205
revprops -- Properties for new revision
200
206
:param local: Perform a local only commit.
201
:param recursive: If set to 'down', commit in any subtrees that have
202
pending changes of any sort during this commit.
204
208
mutter('preparing to commit')
206
if working_tree is None:
207
raise BzrError("working_tree must be passed into commit().")
210
if deprecated_passed(branch):
211
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
212
"deprecated as of bzr 0.8. Please use working_tree= instead.",
213
DeprecationWarning, stacklevel=2)
215
self.work_tree = self.branch.bzrdir.open_workingtree()
216
elif working_tree is None:
217
raise BzrError("One of branch and working_tree must be passed into commit().")
209
219
self.work_tree = working_tree
210
220
self.branch = self.work_tree.branch
211
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
212
if not self.branch.repository.supports_rich_root():
213
raise errors.RootNotRich()
214
if message_callback is None:
215
if message is not None:
216
if isinstance(message, str):
217
message = message.decode(bzrlib.user_encoding)
218
message_callback = lambda x: message
220
raise BzrError("The message or message_callback keyword"
221
" parameter is required for commit().")
222
raise BzrError("The message keyword parameter is required for commit().")
223
224
self.bound_branch = None
224
225
self.local = local
264
258
if self.config is None:
265
259
self.config = self.branch.get_config()
267
# If provided, ensure the specified files are versioned
268
if specific_files is not None:
269
# Note: We don't actually need the IDs here. This routine
270
# is being called because it raises PathNotVerisonedError
271
# as a side effect of finding the IDs.
272
# XXX: Dont we have filter_unversioned to do this more
274
tree.find_ids_across_trees(specific_files,
275
[self.basis_tree, self.work_tree])
277
# Setup the progress bar. As the number of files that need to be
278
# committed in unknown, progress is reported as stages.
279
# We keep track of entries separately though and include that
280
# information in the progress bar during the relevant stages.
281
self.pb_stage_name = ""
282
self.pb_stage_count = 0
283
self.pb_stage_total = 4
284
if self.bound_branch:
285
self.pb_stage_total += 1
286
self.pb.show_pct = False
287
self.pb.show_spinner = False
288
self.pb.show_eta = False
289
self.pb.show_count = True
290
self.pb.show_bar = True
292
# After a merge, a selected file commit is not supported.
293
# See 'bzr help merge' for an explanation as to why.
261
if isinstance(message, str):
262
message = message.decode(bzrlib.user_encoding)
263
assert isinstance(message, unicode), type(message)
264
self.message = message
265
self._escape_commit_message()
267
self.work_inv = self.work_tree.inventory
268
self.basis_tree = self.work_tree.basis_tree()
294
269
self.basis_inv = self.basis_tree.inventory
270
# one to finish, one for rev and inventory, and one for each
271
# inventory entry, and the same for the new inventory.
272
# note that this estimate is too long when we do a partial tree
273
# commit which excludes some new files from being considered.
274
# The estimate is corrected when we populate the new inv.
275
self.pb_total = len(self.work_inv) + 5
295
278
self._gather_parents()
296
279
if len(self.parents) > 1 and self.specific_files:
297
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
299
# Collect the changes
300
self._emit_progress_set_stage("Collecting changes", show_entries=True)
301
self.builder = self.branch.get_commit_builder(self.parents,
280
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
282
self._check_parents_present()
283
self.builder = self.branch.get_commit_builder(self.parents,
302
284
self.config, timestamp, timezone, committer, revprops, rev_id)
303
self._update_builder_with_changes()
304
self._check_pointless()
306
# TODO: Now the new inventory is known, check for conflicts.
286
self._remove_deleted()
287
self._populate_new_inv()
288
self._report_deletes()
290
if not (self.allow_pointless
291
or len(self.parents) > 1
292
or self.builder.new_inventory != self.basis_inv):
293
raise PointlessCommit()
295
self._emit_progress_update()
296
# TODO: Now the new inventory is known, check for conflicts and
297
# prompt the user for a commit message.
307
298
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
308
299
# weave lines, because nothing should be recorded until it is known
309
300
# that commit will succeed.
310
self._emit_progress_set_stage("Saving data locally")
311
301
self.builder.finish_inventory()
313
# Prompt the user for a commit message if none provided
314
message = message_callback(self)
315
assert isinstance(message, unicode), type(message)
316
self.message = message
317
self._escape_commit_message()
319
# Add revision data to the local branch
302
self._emit_progress_update()
320
303
self.rev_id = self.builder.commit(self.message)
304
self._emit_progress_update()
305
# revision data is in the local branch now.
322
# Upload revision data to the master.
307
# upload revision data to the master.
323
308
# this will propagate merged revisions too if needed.
324
309
if self.bound_branch:
325
self._emit_progress_set_stage("Uploading data to master branch")
326
310
self.master_branch.repository.fetch(self.branch.repository,
327
311
revision_id=self.rev_id)
328
312
# now the master has the revision data
329
# 'commit' to the master first so a timeout here causes the
330
# local branch to be out of date
331
self.master_branch.set_last_revision_info(new_revno,
313
# 'commit' to the master first so a timeout here causes the local
314
# branch to be out of date
315
self.master_branch.append_revision(self.rev_id)
334
317
# and now do the commit locally.
335
self.branch.set_last_revision_info(new_revno, self.rev_id)
318
self.branch.append_revision(self.rev_id)
337
# Make the working tree up to date with the branch
338
self._emit_progress_set_stage("Updating the working tree")
339
rev_tree = self.builder.revision_tree()
340
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
341
self.reporter.completed(new_revno, self.rev_id)
342
self._process_hooks(old_revno, new_revno)
320
self.work_tree.set_pending_merges([])
321
self.work_tree.set_last_revision(self.rev_id)
322
# now the work tree is up to date with the branch
324
self.reporter.completed(self.branch.revno(), self.rev_id)
325
if self.config.post_commit() is not None:
326
hooks = self.config.post_commit().split(' ')
327
# this would be nicer with twisted.python.reflect.namedAny
329
result = eval(hook + '(branch, rev_id)',
330
{'branch':self.branch,
332
'rev_id':self.rev_id})
333
self._emit_progress_update()
345
336
return self.rev_id
347
def _any_real_changes(self):
348
"""Are there real changes between new_inventory and basis?
350
For trees without rich roots, inv.root.revision changes every commit.
351
But if that is the only change, we want to treat it as though there
354
new_entries = self.builder.new_inventory.iter_entries()
355
basis_entries = self.basis_inv.iter_entries()
356
new_path, new_root_ie = new_entries.next()
357
basis_path, basis_root_ie = basis_entries.next()
359
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
360
def ie_equal_no_revision(this, other):
361
return ((this.file_id == other.file_id)
362
and (this.name == other.name)
363
and (this.symlink_target == other.symlink_target)
364
and (this.text_sha1 == other.text_sha1)
365
and (this.text_size == other.text_size)
366
and (this.text_id == other.text_id)
367
and (this.parent_id == other.parent_id)
368
and (this.kind == other.kind)
369
and (this.executable == other.executable)
370
and (this.reference_revision == other.reference_revision)
372
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
375
for new_ie, basis_ie in zip(new_entries, basis_entries):
376
if new_ie != basis_ie:
379
# No actual changes present
382
def _check_pointless(self):
383
if self.allow_pointless:
385
# A merge with no effect on files
386
if len(self.parents) > 1:
388
# work around the fact that a newly-initted tree does differ from its
390
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
391
raise PointlessCommit()
392
# Shortcut, if the number of entries changes, then we obviously have
394
if len(self.builder.new_inventory) != len(self.basis_inv):
396
# If length == 1, then we only have the root entry. Which means
397
# that there is no real difference (only the root could be different)
398
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
400
raise PointlessCommit()
402
338
def _check_bound_branch(self):
403
339
"""Check to see if the local branch is bound.
441
377
self.master_branch.lock_write()
442
378
self.master_locked = True
444
def _check_out_of_date_tree(self):
445
"""Check that the working tree is up to date.
447
:return: old_revision_number,new_revision_number tuple
450
first_tree_parent = self.work_tree.get_parent_ids()[0]
452
# if there are no parents, treat our parent as 'None'
453
# this is so that we still consider the master branch
454
# - in a checkout scenario the tree may have no
455
# parents but the branch may do.
456
first_tree_parent = bzrlib.revision.NULL_REVISION
457
old_revno, master_last = self.master_branch.last_revision_info()
458
if master_last != first_tree_parent:
459
if master_last != bzrlib.revision.NULL_REVISION:
460
raise errors.OutOfDateTree(self.work_tree)
461
if self.branch.repository.has_revision(first_tree_parent):
462
new_revno = old_revno + 1
464
# ghost parents never appear in revision history.
466
return old_revno,new_revno
468
def _process_hooks(self, old_revno, new_revno):
469
"""Process any registered commit hooks."""
470
# Process the post commit hooks, if any
471
self._emit_progress_set_stage("Running post commit hooks")
472
# old style commit hooks - should be deprecated ? (obsoleted in
474
if self.config.post_commit() is not None:
475
hooks = self.config.post_commit().split(' ')
476
# this would be nicer with twisted.python.reflect.namedAny
478
result = eval(hook + '(branch, rev_id)',
479
{'branch':self.branch,
481
'rev_id':self.rev_id})
482
# new style commit hooks:
483
if not self.bound_branch:
484
hook_master = self.branch
487
hook_master = self.master_branch
488
hook_local = self.branch
489
# With bound branches, when the master is behind the local branch,
490
# the 'old_revno' and old_revid values here are incorrect.
491
# XXX: FIXME ^. RBC 20060206
493
old_revid = self.parents[0]
495
old_revid = bzrlib.revision.NULL_REVISION
496
for hook in Branch.hooks['post_commit']:
497
# show the running hook in the progress bar. As hooks may
498
# end up doing nothing (e.g. because they are not configured by
499
# the user) this is still showing progress, not showing overall
500
# actions - its up to each plugin to show a UI if it want's to
501
# (such as 'Emailing diff to foo@example.com').
502
self.pb_stage_name = "Running post commit hooks [%s]" % \
503
Branch.hooks.get_hook_name(hook)
504
self._emit_progress()
505
if 'hooks' in debug.debug_flags:
506
mutter("Invoking commit hook: %r", hook)
507
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
510
380
def _cleanup(self):
511
381
"""Cleanup any open locks, progress bars etc."""
512
382
cleanups = [self._cleanup_bound_branch,
513
self.basis_tree.unlock,
514
383
self.work_tree.unlock,
515
384
self.pb.finished]
516
385
found_exception = None
566
435
# TODO: Make sure that this list doesn't contain duplicate
567
436
# entries and the order is preserved when doing this.
568
437
self.parents = self.work_tree.get_parent_ids()
569
self.parent_invs = [self.basis_inv]
570
for revision in self.parents[1:]:
438
self.parent_invs = []
439
for revision in self.parents:
571
440
if self.branch.repository.has_revision(revision):
572
mutter('commit parent revision {%s}', revision)
573
441
inventory = self.branch.repository.get_inventory(revision)
574
442
self.parent_invs.append(inventory)
576
mutter('commit parent ghost revision {%s}', revision)
578
def _update_builder_with_changes(self):
579
"""Update the commit builder with the data about what has changed.
581
# Build the revision inventory.
583
# This starts by creating a new empty inventory. Depending on
584
# which files are selected for commit, and what is present in the
585
# current tree, the new inventory is populated. inventory entries
586
# which are candidates for modification have their revision set to
587
# None; inventory entries that are carried over untouched have their
588
# revision set to their prior value.
444
def _check_parents_present(self):
445
for parent_id in self.parents:
446
mutter('commit parent revision {%s}', parent_id)
447
if not self.branch.repository.has_revision(parent_id):
448
if parent_id == self.branch.last_revision():
449
warning("parent is missing %r", parent_id)
450
raise BzrCheckError("branch %s is missing revision {%s}"
451
% (self.branch, parent_id))
453
def _remove_deleted(self):
454
"""Remove deleted files from the working inventories.
456
This is done prior to taking the working inventory as the
457
basis for the new committed inventory.
459
This returns true if any files
460
*that existed in the basis inventory* were deleted.
461
Files that were added and deleted
462
in the working copy don't matter.
464
specific = self.specific_files
466
for path, ie in self.work_inv.iter_entries():
467
if specific and not is_inside_any(specific, path):
469
if not self.work_tree.has_filename(path):
470
self.reporter.missing(path)
471
deleted_ids.append((path, ie.file_id))
473
deleted_ids.sort(reverse=True)
474
for path, file_id in deleted_ids:
475
del self.work_inv[file_id]
476
self.work_tree._write_inventory(self.work_inv)
478
def _populate_new_inv(self):
479
"""Build revision inventory.
481
This creates a new empty inventory. Depending on
482
which files are selected for commit, and what is present in the
483
current tree, the new inventory is populated. inventory entries
484
which are candidates for modification have their revision set to
485
None; inventory entries that are carried over untouched have their
486
revision set to their prior value.
590
488
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
591
489
# results to create a new inventory at the same time, which results
592
490
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
593
491
# ADHB 11-07-2006
595
specific_files = self.specific_files
596
mutter("Selecting files for commit with filter %s", specific_files)
597
work_inv = self.work_tree.inventory
598
assert work_inv.root is not None
599
self.pb_entries_total = len(work_inv)
601
# Check and warn about old CommitBuilders
602
entries = work_inv.iter_entries()
492
mutter("Selecting files for commit with filter %s", self.specific_files)
493
entries = self.work_inv.iter_entries()
603
494
if not self.builder.record_root_entry:
604
495
symbol_versioning.warn('CommitBuilders should support recording'
605
496
' the root entry as of bzr 0.10.', DeprecationWarning,
607
498
self.builder.new_inventory.add(self.basis_inv.root.copy())
611
deleted_paths = set()
500
self._emit_progress_update()
612
501
for path, new_ie in entries:
613
self._emit_progress_next_entry()
502
self._emit_progress_update()
614
503
file_id = new_ie.file_id
616
# Skip files that have been deleted from the working tree.
617
# The deleted files/directories are also recorded so they
618
# can be explicitly unversioned later. Note that when a
619
# filter of specific files is given, we must only skip/record
620
# deleted files matching that filter.
621
if is_inside_any(deleted_paths, path):
623
if not specific_files or is_inside_any(specific_files, path):
624
if not self.work_tree.has_filename(path):
625
deleted_paths.add(path)
626
self.reporter.missing(path)
627
deleted_ids.append(file_id)
630
kind = self.work_tree.kind(file_id)
631
if kind == 'tree-reference' and self.recursive == 'down':
632
# nested tree: commit in it
633
sub_tree = WorkingTree.open(self.work_tree.abspath(path))
634
# FIXME: be more comprehensive here:
635
# this works when both trees are in --trees repository,
636
# but when both are bound to a different repository,
637
# it fails; a better way of approaching this is to
638
# finally implement the explicit-caches approach design
639
# a while back - RBC 20070306.
640
if (sub_tree.branch.repository.bzrdir.root_transport.base
642
self.work_tree.branch.repository.bzrdir.root_transport.base):
643
sub_tree.branch.repository = \
644
self.work_tree.branch.repository
646
sub_tree.commit(message=None, revprops=self.revprops,
647
recursive=self.recursive,
648
message_callback=self.message_callback,
649
timestamp=self.timestamp, timezone=self.timezone,
650
committer=self.committer,
651
allow_pointless=self.allow_pointless,
652
strict=self.strict, verbose=self.verbose,
653
local=self.local, reporter=self.reporter)
654
except errors.PointlessCommit:
656
if kind != new_ie.kind:
657
new_ie = inventory.make_entry(kind, new_ie.name,
658
new_ie.parent_id, file_id)
659
except errors.NoSuchFile:
661
504
# mutter('check %s {%s}', path, file_id)
662
if (not specific_files or
663
is_inside_or_parent_of_any(specific_files, path)):
505
if (not self.specific_files or
506
is_inside_or_parent_of_any(self.specific_files, path)):
664
507
# mutter('%s selected for commit', path)
665
508
ie = new_ie.copy()
666
509
ie.revision = None
688
532
self.reporter.snapshot_change(change, path)
690
# Unversion IDs that were found to be deleted
691
self.work_tree.unversion(deleted_ids)
693
# If specific files/directories were nominated, it is possible
694
# that some data from outside those needs to be preserved from
695
# the basis tree. For example, if a file x is moved from out of
696
# directory foo into directory bar and the user requests
697
# ``commit foo``, then information about bar/x must also be
700
for path, new_ie in self.basis_inv.iter_entries():
701
if new_ie.file_id in work_inv:
703
if is_inside_any(specific_files, path):
707
self.builder.record_entry_contents(ie, self.parent_invs, path,
710
# Report what was deleted. We could skip this when no deletes are
711
# detected to gain a performance win, but it arguably serves as a
712
# 'safety check' by informing the user whenever anything disappears.
534
if not self.specific_files:
537
# ignore removals that don't match filespec
538
for path, new_ie in self.basis_inv.iter_entries():
539
if new_ie.file_id in self.work_inv:
541
if is_inside_any(self.specific_files, path):
545
self.builder.record_entry_contents(ie, self.parent_invs, path,
548
def _emit_progress_update(self):
549
"""Emit an update to the progress bar."""
550
self.pb.update("Committing", self.pb_count, self.pb_total)
553
def _report_deletes(self):
713
554
for path, ie in self.basis_inv.iter_entries():
714
555
if ie.file_id not in self.builder.new_inventory:
715
556
self.reporter.deleted(path)
717
def _emit_progress_set_stage(self, name, show_entries=False):
718
"""Set the progress stage and emit an update to the progress bar."""
719
self.pb_stage_name = name
720
self.pb_stage_count += 1
721
self.pb_entries_show = show_entries
723
self.pb_entries_count = 0
724
self.pb_entries_total = '?'
725
self._emit_progress()
727
def _emit_progress_next_entry(self):
728
"""Emit an update to the progress bar and increment the file count."""
729
self.pb_entries_count += 1
730
self._emit_progress()
732
def _emit_progress(self):
733
if self.pb_entries_show:
734
text = "%s [Entry %d/%s] - Stage" % (self.pb_stage_name,
735
self.pb_entries_count,str(self.pb_entries_total))
737
text = "%s - Stage" % (self.pb_stage_name)
738
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
