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 (
67
60
from bzrlib.branch import Branch
61
from bzrlib.cleanup import OperationWithCleanups
68
62
import bzrlib.config
69
63
from bzrlib.errors import (BzrError, PointlessCommit,
73
67
from bzrlib.osutils import (get_user_encoding,
74
kind_marker, isdir,isfile, is_inside_any,
75
is_inside_or_parent_of_any,
76
69
minimum_path_selection,
77
quotefn, sha_file, split_lines,
80
from bzrlib.testament import Testament
81
from bzrlib.trace import mutter, note, warning, is_quiet
72
from bzrlib.trace import mutter, note, is_quiet
82
73
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
83
74
from bzrlib import symbol_versioning
84
from bzrlib.symbol_versioning import (deprecated_passed,
87
from bzrlib.workingtree import WorkingTree
88
75
from bzrlib.urlutils import unescape_for_display
76
from bzrlib.i18n import gettext
92
78
class NullCommitReporter(object):
93
79
"""I report on progress of a commit."""
231
263
:param exclude: None or a list of relative paths to exclude from the
232
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):
235
296
mutter('preparing to commit')
237
298
if working_tree is None:
279
340
self.verbose = verbose
281
342
self.work_tree.lock_write()
343
operation.add_cleanup(self.work_tree.unlock)
282
344
self.parents = self.work_tree.get_parent_ids()
283
345
# We can use record_iter_changes IFF iter_changes is compatible with
284
346
# the command line parameters, and the repository has fast delta
285
347
# generation. See bug 347649.
286
348
self.use_record_iter_changes = (
287
not self.specific_files and
288
349
not self.exclude and
289
350
not self.branch.repository._format.supports_tree_reference and
290
351
(self.branch.repository._format.fast_deltas or
291
352
len(self.parents) < 2))
292
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
353
self.pb = ui.ui_factory.nested_progress_bar()
354
operation.add_cleanup(self.pb.finished)
293
355
self.basis_revid = self.work_tree.last_revision()
294
356
self.basis_tree = self.work_tree.basis_tree()
295
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.branch.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")
297
# Cannot commit with conflicts present.
298
if len(self.work_tree.conflicts()) > 0:
299
raise ConflictsInTree
301
# Setup the bound branch variables as needed.
302
self._check_bound_branch(possible_master_transports)
304
# Check that the working tree is up to date
305
old_revno, new_revno = self._check_out_of_date_tree()
307
# Complete configuration setup
308
if reporter is not None:
309
self.reporter = reporter
310
elif self.reporter is None:
311
self.reporter = self._select_reporter()
312
if self.config is None:
313
self.config = self.branch.get_config()
315
self._set_specific_file_ids()
317
# Setup the progress bar. As the number of files that need to be
318
# committed in unknown, progress is reported as stages.
319
# We keep track of entries separately though and include that
320
# information in the progress bar during the relevant stages.
321
self.pb_stage_name = ""
322
self.pb_stage_count = 0
323
self.pb_stage_total = 5
422
self.builder.will_record_deletes()
423
# find the location being committed to
324
424
if self.bound_branch:
325
self.pb_stage_total += 1
326
self.pb.show_pct = False
327
self.pb.show_spinner = False
328
self.pb.show_eta = False
329
self.pb.show_count = True
330
self.pb.show_bar = True
332
self._gather_parents()
333
# After a merge, a selected file commit is not supported.
334
# See 'bzr help merge' for an explanation as to why.
335
if len(self.parents) > 1 and self.specific_files:
336
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
337
# Excludes are a form of selected file commit.
338
if len(self.parents) > 1 and self.exclude:
339
raise errors.CannotCommitSelectedFileMerge(self.exclude)
341
# Collect the changes
342
self._set_progress_stage("Collecting changes", counter=True)
343
self.builder = self.branch.get_commit_builder(self.parents,
344
self.config, timestamp, timezone, committer, revprops, rev_id)
347
self.builder.will_record_deletes()
348
# find the location being committed to
349
if self.bound_branch:
350
master_location = self.master_branch.base
352
master_location = self.branch.base
354
# report the start of the commit
355
self.reporter.started(new_revno, self.rev_id, master_location)
357
self._update_builder_with_changes()
358
self._check_pointless()
360
# TODO: Now the new inventory is known, check for conflicts.
361
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
362
# weave lines, because nothing should be recorded until it is known
363
# that commit will succeed.
364
self._set_progress_stage("Saving data locally")
365
self.builder.finish_inventory()
367
# Prompt the user for a commit message if none provided
368
message = message_callback(self)
369
self.message = message
371
# Add revision data to the local branch
372
self.rev_id = self.builder.commit(self.message)
375
mutter("aborting commit write group because of exception:")
376
trace.log_exception_quietly()
377
note("aborting commit write group: %r" % (e,))
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:
381
480
self._process_pre_hooks(old_revno, new_revno)
383
482
# Upload revision data to the master.
386
485
self._set_progress_stage("Uploading data to master branch")
387
486
# 'commit' to the master first so a timeout here causes the
388
487
# local branch to be out of date
389
self.master_branch.import_last_revision_info(
390
self.branch.repository, new_revno, self.rev_id)
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
493
# and now do the commit locally.
393
494
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)
395
# Make the working tree up to date with the branch
396
self._set_progress_stage("Updating the working tree")
397
self.work_tree.update_basis_by_delta(self.rev_id,
398
self.builder.get_basis_delta())
399
self.reporter.completed(new_revno, self.rev_id)
400
self._process_post_hooks(old_revno, new_revno)
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))) )
405
514
def _select_reporter(self):
406
515
"""Select the CommitReporter to use."""