50
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
50
# the rest of the code; add a deprecation of the old name.
57
from cStringIO import StringIO
53
59
from bzrlib import (
60
67
from bzrlib.branch import Branch
61
from bzrlib.cleanup import OperationWithCleanups
62
68
import bzrlib.config
63
69
from bzrlib.errors import (BzrError, PointlessCommit,
67
73
from bzrlib.osutils import (get_user_encoding,
74
kind_marker, isdir,isfile, is_inside_any,
75
is_inside_or_parent_of_any,
69
76
minimum_path_selection,
77
quotefn, sha_file, split_lines,
72
from bzrlib.trace import mutter, note, is_quiet
80
from bzrlib.testament import Testament
81
from bzrlib.trace import mutter, note, warning, is_quiet
73
82
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
74
83
from bzrlib import symbol_versioning
84
from bzrlib.symbol_versioning import (deprecated_passed,
87
from bzrlib.workingtree import WorkingTree
75
88
from bzrlib.urlutils import unescape_for_display
76
from bzrlib.i18n import gettext
78
92
class NullCommitReporter(object):
79
93
"""I report on progress of a commit."""
128
142
"to started.", DeprecationWarning,
131
self._note(gettext('Committing%s'), location)
145
self._note('Committing%s', location)
133
147
def completed(self, revno, rev_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)
148
self._note('Committed revision %d.', revno)
142
150
def deleted(self, path):
143
self._note(gettext('deleted %s'), path)
151
self._note('deleted %s', path)
145
153
def missing(self, path):
146
self._note(gettext('missing %s'), path)
154
self._note('missing %s', path)
148
156
def renamed(self, change, old_path, new_path):
149
157
self._note('%s %s => %s', change, old_path, new_path)
167
175
def __init__(self,
170
178
"""Create a Commit object.
172
180
:param reporter: the default reporter to use or None to decide later
174
182
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
263
233
:param exclude: None or a list of relative paths to exclude from the
264
234
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):
296
237
mutter('preparing to commit')
298
239
if working_tree is None:
350
292
not self.branch.repository._format.supports_tree_reference and
351
293
(self.branch.repository._format.fast_deltas or
352
294
len(self.parents) < 2))
353
self.pb = ui.ui_factory.nested_progress_bar()
354
operation.add_cleanup(self.pb.finished)
295
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
355
296
self.basis_revid = self.work_tree.last_revision()
356
297
self.basis_tree = self.work_tree.basis_tree()
357
298
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")
422
self.builder.will_record_deletes()
423
# find the location being committed to
300
# Cannot commit with conflicts present.
301
if len(self.work_tree.conflicts()) > 0:
302
raise ConflictsInTree
304
# Setup the bound branch variables as needed.
305
self._check_bound_branch(possible_master_transports)
307
# Check that the working tree is up to date
308
old_revno, new_revno = self._check_out_of_date_tree()
310
# Complete configuration setup
311
if reporter is not None:
312
self.reporter = reporter
313
elif self.reporter is None:
314
self.reporter = self._select_reporter()
315
if self.config is None:
316
self.config = self.branch.get_config()
318
self._set_specific_file_ids()
320
# Setup the progress bar. As the number of files that need to be
321
# committed in unknown, progress is reported as stages.
322
# We keep track of entries separately though and include that
323
# information in the progress bar during the relevant stages.
324
self.pb_stage_name = ""
325
self.pb_stage_count = 0
326
self.pb_stage_total = 5
424
327
if self.bound_branch:
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)
432
self._update_builder_with_changes()
433
self._check_pointless()
435
# TODO: Now the new inventory is known, check for conflicts.
436
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
437
# weave lines, because nothing should be recorded until it is known
438
# that commit will succeed.
439
self._set_progress_stage("Saving data locally")
440
self.builder.finish_inventory()
442
# Prompt the user for a commit message if none provided
443
message = message_callback(self)
444
self.message = message
446
# Add revision data to the local branch
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:
328
self.pb_stage_total += 1
329
self.pb.show_pct = False
330
self.pb.show_spinner = False
331
self.pb.show_eta = False
332
self.pb.show_count = True
333
self.pb.show_bar = True
335
self._gather_parents()
336
# After a merge, a selected file commit is not supported.
337
# See 'bzr help merge' for an explanation as to why.
338
if len(self.parents) > 1 and self.specific_files is not None:
339
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
340
# Excludes are a form of selected file commit.
341
if len(self.parents) > 1 and self.exclude:
342
raise errors.CannotCommitSelectedFileMerge(self.exclude)
344
# Collect the changes
345
self._set_progress_stage("Collecting changes", counter=True)
346
self.builder = self.branch.get_commit_builder(self.parents,
347
self.config, timestamp, timezone, committer, revprops, rev_id)
350
self.builder.will_record_deletes()
351
# find the location being committed to
352
if self.bound_branch:
353
master_location = self.master_branch.base
355
master_location = self.branch.base
357
# report the start of the commit
358
self.reporter.started(new_revno, self.rev_id, master_location)
360
self._update_builder_with_changes()
361
self._check_pointless()
363
# TODO: Now the new inventory is known, check for conflicts.
364
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
365
# weave lines, because nothing should be recorded until it is known
366
# that commit will succeed.
367
self._set_progress_stage("Saving data locally")
368
self.builder.finish_inventory()
370
# Prompt the user for a commit message if none provided
371
message = message_callback(self)
372
self.message = message
374
# Add revision data to the local branch
375
self.rev_id = self.builder.commit(self.message)
378
mutter("aborting commit write group because of exception:")
379
trace.log_exception_quietly()
380
note("aborting commit write group: %r" % (e,))
480
384
self._process_pre_hooks(old_revno, new_revno)
482
386
# Upload revision data to the master.
485
389
self._set_progress_stage("Uploading data to master branch")
486
390
# 'commit' to the master first so a timeout here causes the
487
391
# local branch to be out of date
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)
392
self.master_branch.import_last_revision_info(
393
self.branch.repository, new_revno, self.rev_id)
493
395
# and now do the commit locally.
494
396
self.branch.set_last_revision_info(new_revno, self.rev_id)
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))) )
398
# Make the working tree be up to date with the branch. This
399
# includes automatic changes scheduled to be made to the tree, such
400
# as updating its basis and unversioning paths that were missing.
401
self.work_tree.unversion(self.deleted_ids)
402
self._set_progress_stage("Updating the working tree")
403
self.work_tree.update_basis_by_delta(self.rev_id,
404
self.builder.get_basis_delta())
405
self.reporter.completed(new_revno, self.rev_id)
406
self._process_post_hooks(old_revno, new_revno)
514
411
def _select_reporter(self):
515
412
"""Select the CommitReporter to use."""
661
565
old_revno, old_revid, new_revno, self.rev_id,
662
566
tree_delta, future_tree)
569
"""Cleanup any open locks, progress bars etc."""
570
cleanups = [self._cleanup_bound_branch,
571
self.basis_tree.unlock,
572
self.work_tree.unlock,
574
found_exception = None
575
for cleanup in cleanups:
578
# we want every cleanup to run no matter what.
579
# so we have a catchall here, but we will raise the
580
# last encountered exception up the stack: and
581
# typically this will be useful enough.
584
if found_exception is not None:
585
# don't do a plan raise, because the last exception may have been
586
# trashed, e is our sure-to-work exception even though it loses the
587
# full traceback. XXX: RBC 20060421 perhaps we could check the
588
# exc_info and if its the same one do a plain raise otherwise
589
# 'raise e' as we do now.
592
def _cleanup_bound_branch(self):
593
"""Executed at the end of a try/finally to cleanup a bound branch.
595
If the branch wasn't bound, this is a no-op.
596
If it was, it resents self.branch to the local branch, instead
599
if not self.bound_branch:
601
if self.master_locked:
602
self.master_branch.unlock()
664
604
def _gather_parents(self):
665
605
"""Record the parents of a merge for merge detection."""
666
606
# TODO: Make sure that this list doesn't contain duplicate
667
607
# entries and the order is preserved when doing this.
668
608
if self.use_record_iter_changes:
670
self.basis_inv = self.basis_tree.root_inventory
610
self.basis_inv = self.basis_tree.inventory
671
611
self.parent_invs = [self.basis_inv]
672
612
for revision in self.parents[1:]:
673
613
if self.branch.repository.has_revision(revision):
added
removed
bzrlib/commit.py
