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
59
from .branch import Branch
60
from .cleanup import ExitStack
62
from .errors import (BzrError,
66
from .osutils import (get_user_encoding,
69
minimum_path_selection,
71
from .trace import mutter, note, is_quiet
72
from .tree import TreeChange
73
from .urlutils import unescape_for_display
74
from .i18n import gettext
77
class PointlessCommit(BzrError):
79
_fmt = "No changes to commit"
82
class CannotCommitSelectedFileMerge(BzrError):
84
_fmt = 'Selected-file commit of merges is not supported yet:'\
85
' files %(files_str)s'
87
def __init__(self, files):
88
files_str = ', '.join(files)
89
BzrError.__init__(self, files=files, files_str=files_str)
92
def filter_excluded(iter_changes, exclude):
93
"""Filter exclude filenames.
95
:param iter_changes: iter_changes function
96
:param exclude: List of paths to exclude
97
:return: iter_changes function
99
for change in iter_changes:
100
new_excluded = (change.path[1] is not None and
101
is_inside_any(exclude, change.path[1]))
103
old_excluded = (change.path[0] is not None and
104
is_inside_any(exclude, change.path[0]))
106
if old_excluded and new_excluded:
109
if old_excluded or new_excluded:
110
# TODO(jelmer): Perhaps raise an error here instead?
65
from bzrlib.branch import Branch
67
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
minimum_path_selection,
74
quotefn, sha_file, split_lines)
75
from bzrlib.testament import Testament
76
from bzrlib.trace import mutter, note, warning, is_quiet
77
from bzrlib.xml5 import serializer_v5
78
from bzrlib.inventory import InventoryEntry, make_entry
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (deprecated_passed,
83
from bzrlib.workingtree import WorkingTree
84
from bzrlib.urlutils import unescape_for_display
116
88
class NullCommitReporter(object):
117
89
"""I report on progress of a commit."""
119
def started(self, revno, revid, location):
91
def started(self, revno, revid, location=None):
122
94
def snapshot_change(self, change, path):
279
221
:param verbose: if True and the reporter is not None, report everything
280
222
:param recursive: If set to 'down', commit in any subtrees that have
281
223
pending changes of any sort during this commit.
282
:param exclude: None or a list of relative paths to exclude from the
283
commit. Pending changes to excluded files will be ignored by the
285
:param lossy: When committing to a foreign VCS, ignore any
286
data that can not be natively represented.
288
with ExitStack() as stack:
289
self.revprops = revprops or {}
290
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
291
self.config_stack = config or self.config_stack
292
mutter('preparing to commit')
294
if working_tree is None:
295
raise BzrError("working_tree must be passed into commit().")
297
self.work_tree = working_tree
298
self.branch = self.work_tree.branch
299
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
300
if not self.branch.repository.supports_rich_root():
301
raise errors.RootNotRich()
302
if message_callback is None:
303
if message is not None:
304
if isinstance(message, bytes):
305
message = message.decode(get_user_encoding())
307
def message_callback(x):
310
raise BzrError("The message or message_callback keyword"
311
" parameter is required for commit().")
313
self.bound_branch = None
314
self.any_entries_deleted = False
315
if exclude is not None:
316
self.exclude = sorted(
317
minimum_path_selection(exclude))
321
self.master_branch = None
322
self.recursive = recursive
324
# self.specific_files is None to indicate no filter, or any iterable to
325
# indicate a filter - [] means no files at all, as per iter_changes.
326
if specific_files is not None:
327
self.specific_files = sorted(
328
minimum_path_selection(specific_files))
330
self.specific_files = None
332
self.allow_pointless = allow_pointless
333
self.message_callback = message_callback
334
self.timestamp = timestamp
335
self.timezone = timezone
336
self.committer = committer
338
self.verbose = verbose
340
stack.enter_context(self.work_tree.lock_write())
341
self.parents = self.work_tree.get_parent_ids()
342
self.pb = ui.ui_factory.nested_progress_bar()
343
stack.callback(self.pb.finished)
344
self.basis_revid = self.work_tree.last_revision()
345
self.basis_tree = self.work_tree.basis_tree()
346
stack.enter_context(self.basis_tree.lock_read())
225
mutter('preparing to commit')
227
if working_tree is None:
228
raise BzrError("working_tree must be passed into commit().")
230
self.work_tree = working_tree
231
self.branch = self.work_tree.branch
232
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
233
if not self.branch.repository.supports_rich_root():
234
raise errors.RootNotRich()
235
if message_callback is None:
236
if message is not None:
237
if isinstance(message, str):
238
message = message.decode(bzrlib.user_encoding)
239
message_callback = lambda x: message
241
raise BzrError("The message or message_callback keyword"
242
" parameter is required for commit().")
244
self.bound_branch = None
245
self.any_entries_changed = False
246
self.any_entries_deleted = False
248
self.master_branch = None
249
self.master_locked = False
250
self.recursive = recursive
252
if specific_files is not None:
253
self.specific_files = sorted(
254
minimum_path_selection(specific_files))
256
self.specific_files = None
257
self.specific_file_ids = None
258
self.allow_pointless = allow_pointless
259
self.revprops = revprops
260
self.message_callback = message_callback
261
self.timestamp = timestamp
262
self.timezone = timezone
263
self.committer = committer
265
self.verbose = verbose
266
# accumulates an inventory delta to the basis entry, so we can make
267
# just the necessary updates to the workingtree's cached basis.
268
self._basis_delta = []
270
self.work_tree.lock_write()
271
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
272
self.basis_revid = self.work_tree.last_revision()
273
self.basis_tree = self.work_tree.basis_tree()
274
self.basis_tree.lock_read()
347
276
# Cannot commit with conflicts present.
348
277
if len(self.work_tree.conflicts()) > 0:
349
278
raise ConflictsInTree
351
280
# Setup the bound branch variables as needed.
352
self._check_bound_branch(stack, possible_master_transports)
353
if self.config_stack is None:
354
self.config_stack = self.work_tree.get_config_stack()
281
self._check_bound_branch()
356
283
# Check that the working tree is up to date
357
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
284
old_revno, new_revno = self._check_out_of_date_tree()
359
286
# Complete configuration setup
360
287
if reporter is not None:
361
288
self.reporter = reporter
362
289
elif self.reporter is None:
363
290
self.reporter = self._select_reporter()
291
if self.config is None:
292
self.config = self.branch.get_config()
294
# If provided, ensure the specified files are versioned
295
if self.specific_files is not None:
296
# Note: This routine is being called because it raises
297
# PathNotVersionedError as a side effect of finding the IDs. We
298
# later use the ids we found as input to the working tree
299
# inventory iterator, so we only consider those ids rather than
300
# examining the whole tree again.
301
# XXX: Dont we have filter_unversioned to do this more
303
self.specific_file_ids = tree.find_ids_across_trees(
304
specific_files, [self.basis_tree, self.work_tree])
365
306
# Setup the progress bar. As the number of files that need to be
366
307
# committed in unknown, progress is reported as stages.
423
355
# Prompt the user for a commit message if none provided
424
356
message = message_callback(self)
357
assert isinstance(message, unicode), type(message)
425
358
self.message = message
359
self._escape_commit_message()
427
361
# Add revision data to the local branch
428
362
self.rev_id = self.builder.commit(self.message)
431
mutter("aborting commit write group because of exception:")
432
trace.log_exception_quietly()
433
365
self.builder.abort()
436
self._update_branches(old_revno, old_revid, new_revno)
438
# Make the working tree be up to date with the branch. This
439
# includes automatic changes scheduled to be made to the tree, such
440
# as updating its basis and unversioning paths that were missing.
441
self.work_tree.unversion(self.deleted_paths)
442
self._set_progress_stage("Updating the working tree")
443
self.work_tree.update_basis_by_delta(self.rev_id,
444
self.builder.get_basis_delta())
445
self.reporter.completed(new_revno, self.rev_id)
446
self._process_post_hooks(old_revno, new_revno)
449
def _update_branches(self, old_revno, old_revid, new_revno):
450
"""Update the master and local branch to the new revision.
452
This will try to make sure that the master branch is updated
453
before the local branch.
455
:param old_revno: Revision number of master branch before the
457
:param old_revid: Tip of master branch before the commit
458
:param new_revno: Revision number of the new commit
460
if not self.builder.updates_branch:
461
368
self._process_pre_hooks(old_revno, new_revno)
463
370
# Upload revision data to the master.
464
371
# this will propagate merged revisions too if needed.
465
372
if self.bound_branch:
466
373
self._set_progress_stage("Uploading data to master branch")
374
self.master_branch.repository.fetch(self.branch.repository,
375
revision_id=self.rev_id)
376
# now the master has the revision data
467
377
# 'commit' to the master first so a timeout here causes the
468
378
# local branch to be out of date
469
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
470
self.branch, new_revno, self.rev_id, lossy=self._lossy)
472
self.branch.fetch(self.master_branch, self.rev_id)
379
self.master_branch.set_last_revision_info(new_revno,
474
382
# and now do the commit locally.
475
if new_revno is None:
476
# Keep existing behaviour around ghosts
478
383
self.branch.set_last_revision_info(new_revno, self.rev_id)
481
self._process_pre_hooks(old_revno, new_revno)
482
except BaseException:
483
# The commit builder will already have updated the branch,
485
self.branch.set_last_revision_info(old_revno, old_revid)
488
# Merge local tags to remote
489
if self.bound_branch:
490
self._set_progress_stage("Merging tags to master branch")
491
tag_updates, tag_conflicts = self.branch.tags.merge_to(
492
self.master_branch.tags)
494
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
495
note(gettext("Conflicting tags in bound branch:\n{0}".format(
496
"\n".join(warning_lines))))
385
# Make the working tree up to date with the branch
386
self._set_progress_stage("Updating the working tree")
387
self.work_tree.update_basis_by_delta(self.rev_id,
389
self.reporter.completed(new_revno, self.rev_id)
390
self._process_post_hooks(old_revno, new_revno)
498
395
def _select_reporter(self):
499
396
"""Select the CommitReporter to use."""
654
551
old_revno, old_revid, new_revno, self.rev_id,
655
552
tree_delta, future_tree)
555
"""Cleanup any open locks, progress bars etc."""
556
cleanups = [self._cleanup_bound_branch,
557
self.basis_tree.unlock,
558
self.work_tree.unlock,
560
found_exception = None
561
for cleanup in cleanups:
564
# we want every cleanup to run no matter what.
565
# so we have a catchall here, but we will raise the
566
# last encountered exception up the stack: and
567
# typically this will be useful enough.
570
if found_exception is not None:
571
# don't do a plan raise, because the last exception may have been
572
# trashed, e is our sure-to-work exception even though it loses the
573
# full traceback. XXX: RBC 20060421 perhaps we could check the
574
# exc_info and if its the same one do a plain raise otherwise
575
# 'raise e' as we do now.
578
def _cleanup_bound_branch(self):
579
"""Executed at the end of a try/finally to cleanup a bound branch.
581
If the branch wasn't bound, this is a no-op.
582
If it was, it resents self.branch to the local branch, instead
585
if not self.bound_branch:
587
if self.master_locked:
588
self.master_branch.unlock()
590
def _escape_commit_message(self):
591
"""Replace xml-incompatible control characters."""
592
# FIXME: RBC 20060419 this should be done by the revision
593
# serialiser not by commit. Then we can also add an unescaper
594
# in the deserializer and start roundtripping revision messages
595
# precisely. See repository_implementations/test_repository.py
597
# Python strings can include characters that can't be
598
# represented in well-formed XML; escape characters that
599
# aren't listed in the XML specification
600
# (http://www.w3.org/TR/REC-xml/#NT-Char).
601
self.message, escape_count = re.subn(
602
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
603
lambda match: match.group(0).encode('unicode_escape'),
606
self.reporter.escaped(escape_count, self.message)
608
def _gather_parents(self):
609
"""Record the parents of a merge for merge detection."""
610
# TODO: Make sure that this list doesn't contain duplicate
611
# entries and the order is preserved when doing this.
612
self.parents = self.work_tree.get_parent_ids()
613
self.parent_invs = [self.basis_inv]
614
for revision in self.parents[1:]:
615
if self.branch.repository.has_revision(revision):
616
mutter('commit parent revision {%s}', revision)
617
inventory = self.branch.repository.get_inventory(revision)
618
self.parent_invs.append(inventory)
620
mutter('commit parent ghost revision {%s}', revision)
657
622
def _update_builder_with_changes(self):
658
623
"""Update the commit builder with the data about what has changed.
625
# Build the revision inventory.
627
# This starts by creating a new empty inventory. Depending on
628
# which files are selected for commit, and what is present in the
629
# current tree, the new inventory is populated. inventory entries
630
# which are candidates for modification have their revision set to
631
# None; inventory entries that are carried over untouched have their
632
# revision set to their prior value.
634
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
635
# results to create a new inventory at the same time, which results
636
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
660
639
specific_files = self.specific_files
661
mutter("Selecting files for commit with filter %r", specific_files)
664
iter_changes = self.work_tree.iter_changes(
665
self.basis_tree, specific_files=specific_files)
667
iter_changes = filter_excluded(iter_changes, self.exclude)
668
iter_changes = self._filter_iter_changes(iter_changes)
669
for path, fs_hash in self.builder.record_iter_changes(
670
self.work_tree, self.basis_revid, iter_changes):
671
self.work_tree._observed_sha1(path, fs_hash)
673
def _filter_iter_changes(self, iter_changes):
674
"""Process iter_changes.
676
This method reports on the changes in iter_changes to the user, and
677
converts 'missing' entries in the iter_changes iterator to 'deleted'
678
entries. 'missing' entries have their
680
:param iter_changes: An iter_changes to process.
681
:return: A generator of changes.
683
reporter = self.reporter
684
report_changes = reporter.is_verbose()
686
for change in iter_changes:
688
old_path = change.path[0]
689
new_path = change.path[1]
690
versioned = change.versioned[1]
691
kind = change.kind[1]
692
versioned = change.versioned[1]
693
if kind is None and versioned:
696
reporter.missing(new_path)
697
if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
698
trace.warning('Ignoring "%s" as symlinks are not '
699
'supported on this filesystem.' % (change.path[0],))
701
deleted_paths.append(change.path[1])
702
# Reset the new path (None) and new versioned flag (False)
703
change = change.discard_new()
704
new_path = change.path[1]
706
elif kind == 'tree-reference':
707
if self.recursive == 'down':
708
self._commit_nested_tree(change.path[1])
709
if change.versioned[0] or change.versioned[1]:
713
reporter.deleted(old_path)
714
elif old_path is None:
715
reporter.snapshot_change(gettext('added'), new_path)
716
elif old_path != new_path:
717
reporter.renamed(gettext('renamed'),
721
or self.work_tree.branch.repository._format.rich_root_data):
722
# Don't report on changes to '' in non rich root
724
reporter.snapshot_change(
725
gettext('modified'), new_path)
726
self._next_progress_entry()
727
# Unversion files that were found to be deleted
728
self.deleted_paths = deleted_paths
730
def _check_strict(self):
731
# XXX: when we use iter_changes this would likely be faster if
732
# iter_changes would check for us (even in the presence of
640
mutter("Selecting files for commit with filter %s", specific_files)
642
# Build the new inventory
643
self._populate_from_inventory(specific_files)
645
# If specific files are selected, then all un-selected files must be
646
# recorded in their previous state. For more details, see
647
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
649
for path, old_ie in self.basis_inv.iter_entries():
650
if old_ie.file_id in self.builder.new_inventory:
651
# already added - skip.
653
if is_inside_any(specific_files, path):
654
# was inside the selected path, if not present it has been
657
if old_ie.kind == 'directory':
658
self._next_progress_entry()
659
# not in final inv yet, was not in the selected files, so is an
660
# entry to be preserved unaltered.
662
# Note: specific file commits after a merge are currently
663
# prohibited. This test is for sanity/safety in case it's
664
# required after that changes.
665
if len(self.parents) > 1:
667
delta, version_recorded = self.builder.record_entry_contents(
668
ie, self.parent_invs, path, self.basis_tree, None)
670
self.any_entries_changed = True
671
if delta: self._basis_delta.append(delta)
673
def _report_and_accumulate_deletes(self):
674
# XXX: Could the list of deleted paths and ids be instead taken from
675
# _populate_from_inventory?
676
deleted_ids = set(self.basis_inv._byid.keys()) - \
677
set(self.builder.new_inventory._byid.keys())
679
self.any_entries_deleted = True
680
deleted = [(self.basis_tree.id2path(file_id), file_id)
681
for file_id in deleted_ids]
683
# XXX: this is not quite directory-order sorting
684
for path, file_id in deleted:
685
self._basis_delta.append((path, None, file_id, None))
686
self.reporter.deleted(path)
688
def _populate_from_inventory(self, specific_files):
689
"""Populate the CommitBuilder by walking the working tree inventory."""
735
691
# raise an exception as soon as we find a single unknown.
736
692
for unknown in self.work_tree.unknowns():
737
693
raise StrictCommitFailed()
739
def _commit_nested_tree(self, path):
695
report_changes = self.reporter.is_verbose()
697
deleted_paths = set()
698
# XXX: Note that entries may have the wrong kind because the entry does
699
# not reflect the status on disk.
700
work_inv = self.work_tree.inventory
701
entries = work_inv.iter_entries_by_dir(
702
specific_file_ids=self.specific_file_ids, yield_parents=True)
703
for path, existing_ie in entries:
704
file_id = existing_ie.file_id
705
name = existing_ie.name
706
parent_id = existing_ie.parent_id
707
kind = existing_ie.kind
708
if kind == 'directory':
709
self._next_progress_entry()
710
# Skip files that have been deleted from the working tree.
711
# The deleted files/directories are also recorded so they
712
# can be explicitly unversioned later. Note that when a
713
# filter of specific files is given, we must only skip/record
714
# deleted files matching that filter.
715
if is_inside_any(deleted_paths, path):
717
content_summary = self.work_tree.path_content_summary(path)
718
if not specific_files or is_inside_any(specific_files, path):
719
if content_summary[0] == 'missing':
720
deleted_paths.add(path)
721
self.reporter.missing(path)
722
deleted_ids.append(file_id)
724
# TODO: have the builder do the nested commit just-in-time IF and
726
if content_summary[0] == 'tree-reference':
727
# enforce repository nested tree policy.
728
if (not self.work_tree.supports_tree_reference() or
729
# repository does not support it either.
730
not self.branch.repository._format.supports_tree_reference):
731
content_summary = ('directory',) + content_summary[1:]
732
kind = content_summary[0]
733
# TODO: specific_files filtering before nested tree processing
734
if kind == 'tree-reference':
735
if self.recursive == 'down':
736
nested_revision_id = self._commit_nested_tree(
738
content_summary = content_summary[:3] + (
741
content_summary = content_summary[:3] + (
742
self.work_tree.get_reference_revision(file_id),)
744
# Record an entry for this item
745
# Note: I don't particularly want to have the existing_ie
746
# parameter but the test suite currently (28-Jun-07) breaks
747
# without it thanks to a unicode normalisation issue. :-(
748
definitely_changed = kind != existing_ie.kind
749
self._record_entry(path, file_id, specific_files, kind, name,
750
parent_id, definitely_changed, existing_ie, report_changes,
753
# Unversion IDs that were found to be deleted
754
self.work_tree.unversion(deleted_ids)
756
def _commit_nested_tree(self, file_id, path):
740
757
"Commit a nested tree."
741
sub_tree = self.work_tree.get_nested_tree(path)
758
sub_tree = self.work_tree.get_nested_tree(file_id, path)
742
759
# FIXME: be more comprehensive here:
743
760
# this works when both trees are in --trees repository,
744
761
# but when both are bound to a different repository,
745
# it fails; a better way of approaching this is to
762
# it fails; a better way of approaching this is to
746
763
# finally implement the explicit-caches approach design
747
764
# a while back - RBC 20070306.
748
765
if sub_tree.branch.repository.has_same_location(
749
self.work_tree.branch.repository):
766
self.work_tree.branch.repository):
750
767
sub_tree.branch.repository = \
751
768
self.work_tree.branch.repository
753
770
return sub_tree.commit(message=None, revprops=self.revprops,
754
recursive=self.recursive,
755
message_callback=self.message_callback,
756
timestamp=self.timestamp,
757
timezone=self.timezone,
758
committer=self.committer,
759
allow_pointless=self.allow_pointless,
760
strict=self.strict, verbose=self.verbose,
761
local=self.local, reporter=self.reporter)
762
except PointlessCommit:
763
return self.work_tree.get_reference_revision(path)
765
def _set_progress_stage(self, name, counter=False):
771
recursive=self.recursive,
772
message_callback=self.message_callback,
773
timestamp=self.timestamp, timezone=self.timezone,
774
committer=self.committer,
775
allow_pointless=self.allow_pointless,
776
strict=self.strict, verbose=self.verbose,
777
local=self.local, reporter=self.reporter)
778
except errors.PointlessCommit:
779
return self.work_tree.get_reference_revision(file_id)
781
def _record_entry(self, path, file_id, specific_files, kind, name,
782
parent_id, definitely_changed, existing_ie, report_changes,
784
"Record the new inventory entry for a path if any."
785
# mutter('check %s {%s}', path, file_id)
786
# mutter('%s selected for commit', path)
787
if definitely_changed or existing_ie is None:
788
ie = make_entry(kind, name, parent_id, file_id)
790
ie = existing_ie.copy()
792
delta, version_recorded = self.builder.record_entry_contents(ie,
793
self.parent_invs, path, self.work_tree, content_summary)
795
self._basis_delta.append(delta)
797
self.any_entries_changed = True
799
self._report_change(ie, path)
802
def _report_change(self, ie, path):
803
"""Report a change to the user.
805
The change that has occurred is described relative to the basis
808
if (self.basis_inv.has_id(ie.file_id)):
809
basis_ie = self.basis_inv[ie.file_id]
812
change = ie.describe_change(basis_ie, ie)
813
if change in (InventoryEntry.RENAMED,
814
InventoryEntry.MODIFIED_AND_RENAMED):
815
old_path = self.basis_inv.id2path(ie.file_id)
816
self.reporter.renamed(change, old_path, path)
818
self.reporter.snapshot_change(change, path)
820
def _set_progress_stage(self, name, entries_title=None):
766
821
"""Set the progress stage and emit an update to the progress bar."""
767
822
self.pb_stage_name = name
768
823
self.pb_stage_count += 1
824
self.pb_entries_title = entries_title
825
if entries_title is not None:
770
826
self.pb_entries_count = 0
772
self.pb_entries_count = None
827
self.pb_entries_total = '?'
773
828
self._emit_progress()
775
830
def _next_progress_entry(self):
added
removed
bzrlib/commit.py
