1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
# The newly committed revision is going to have a shape corresponding
20
# to that of the working tree. Files that are not in the
21
# working tree and that were in the predecessor are reported as
22
# removed --- this can include files that were either removed from the
23
# inventory or deleted in the working tree. If they were only
24
# deleted from disk, they are removed from the working inventory.
26
# We then consider the remaining entries, which will be in the new
27
# version. Directory entries are simply copied across. File entries
28
# must be checked to see if a new version of the file should be
29
# recorded. For each parent revision tree, we check to see what
30
# version of the file was present. If the file was present in at
31
# least one tree, and if it was the same version in all the trees,
32
# then we can just refer to that version. Otherwise, a new version
33
# representing the merger of the file versions must be added.
35
# TODO: Update hashcache before and after - or does the WorkingTree
38
# TODO: Rather than mashing together the ancestry and storing it back,
39
# perhaps the weave should have single method which does it all in one
40
# go, avoiding a lot of redundant work.
42
# TODO: Perhaps give a warning if one of the revisions marked as
43
# merged is already in the ancestry, and then don't record it as a
46
# TODO: If the file is newly merged but unchanged from the version it
47
# merges from, then it should still be reported as newly added
48
# relative to the basis revision.
50
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
# the rest of the code; add a deprecation of the old name.
60
from .branch import Branch
61
from .cleanup import OperationWithCleanups
63
from .errors import (BzrError,
67
from .osutils import (get_user_encoding,
69
minimum_path_selection,
72
from .trace import mutter, note, is_quiet
73
from .bzr.inventory import Inventory, InventoryEntry, make_entry
74
from .urlutils import unescape_for_display
75
from .i18n import gettext
78
class PointlessCommit(BzrError):
80
_fmt = "No changes to commit"
83
class CannotCommitSelectedFileMerge(BzrError):
85
_fmt = 'Selected-file commit of merges is not supported yet:'\
86
' files %(files_str)s'
88
def __init__(self, files):
89
files_str = ', '.join(files)
90
BzrError.__init__(self, files=files, files_str=files_str)
93
def filter_excluded(iter_changes, exclude):
94
"""Filter exclude filenames.
96
:param iter_changes: iter_changes function
97
:param exclude: List of paths to exclude
98
:return: iter_changes function
100
for change in iter_changes:
101
old_path = change[1][0]
102
new_path = change[1][1]
104
new_excluded = (new_path is not None and
105
is_inside_any(exclude, new_path))
107
old_excluded = (old_path is not None and
108
is_inside_any(exclude, old_path))
110
if old_excluded and new_excluded:
113
if old_excluded or new_excluded:
114
# TODO(jelmer): Perhaps raise an error here instead?
120
class NullCommitReporter(object):
121
"""I report on progress of a commit."""
123
def started(self, revno, revid, location):
126
def snapshot_change(self, change, path):
129
def completed(self, revno, rev_id):
132
def deleted(self, path):
135
def missing(self, path):
138
def renamed(self, change, old_path, new_path):
141
def is_verbose(self):
145
class ReportCommitToLog(NullCommitReporter):
147
def _note(self, format, *args):
150
Subclasses may choose to override this method.
154
def snapshot_change(self, change, path):
155
if path == '' and change in (gettext('added'), gettext('modified')):
157
self._note("%s %s", change, path)
159
def started(self, revno, rev_id, location):
161
gettext('Committing to: %s'),
162
unescape_for_display(location, 'utf-8'))
164
def completed(self, revno, rev_id):
165
self._note(gettext('Committed revision %d.'), revno)
166
# self._note goes to the console too; so while we want to log the
167
# rev_id, we can't trivially only log it. (See bug 526425). Long
168
# term we should rearrange the reporting structure, but for now
169
# we just mutter seperately. We mutter the revid and revno together
170
# so that concurrent bzr invocations won't lead to confusion.
171
mutter('Committed revid %s as revno %d.', rev_id, revno)
173
def deleted(self, path):
174
self._note(gettext('deleted %s'), path)
176
def missing(self, path):
177
self._note(gettext('missing %s'), path)
179
def renamed(self, change, old_path, new_path):
180
self._note('%s %s => %s', change, old_path, new_path)
182
def is_verbose(self):
186
class Commit(object):
187
"""Task of committing a new revision.
189
This is a MethodObject: it accumulates state as the commit is
190
prepared, and then it is discarded. It doesn't represent
191
historical revisions, just the act of recording a new one.
194
Modified to hold a list of files that have been deleted from
195
the working directory; these should be removed from the
201
"""Create a Commit object.
203
:param reporter: the default reporter to use or None to decide later
205
self.reporter = reporter
206
self.config_stack = config_stack
209
def update_revprops(revprops, branch, authors=None,
210
local=False, possible_master_transports=None):
213
if possible_master_transports is None:
214
possible_master_transports = []
215
if (not 'branch-nick' in revprops and
216
branch.repository._format.supports_storing_branch_nick):
217
revprops['branch-nick'] = branch._get_nick(
219
possible_master_transports)
220
if authors is not None:
221
if 'author' in revprops or 'authors' in revprops:
222
# XXX: maybe we should just accept one of them?
223
raise AssertionError('author property given twice')
225
for individual in authors:
226
if '\n' in individual:
227
raise AssertionError('\\n is not a valid character '
228
'in an author identity')
229
revprops['authors'] = '\n'.join(authors)
239
allow_pointless=True,
247
message_callback=None,
250
possible_master_transports=None,
252
"""Commit working copy as a new revision.
254
:param message: the commit message (it or message_callback is required)
255
:param message_callback: A callback: message = message_callback(cmt_obj)
257
:param timestamp: if not None, seconds-since-epoch for a
258
postdated/predated commit.
260
:param specific_files: If not None, commit only those files. An empty
261
list means 'commit no files'.
263
:param rev_id: If set, use this as the new revision id.
264
Useful for test or import commands that need to tightly
265
control what revisions are assigned. If you duplicate
266
a revision id that exists elsewhere it is your own fault.
267
If null (default), a time/random revision id is generated.
269
:param allow_pointless: If true (default), commit even if nothing
270
has changed and no merges are recorded.
272
:param strict: If true, don't allow a commit if the working tree
273
contains unknown files.
275
:param revprops: Properties for new revision
276
:param local: Perform a local only commit.
277
:param reporter: the reporter to use or None for the default
278
:param verbose: if True and the reporter is not None, report everything
279
:param recursive: If set to 'down', commit in any subtrees that have
280
pending changes of any sort during this commit.
281
:param exclude: None or a list of relative paths to exclude from the
282
commit. Pending changes to excluded files will be ignored by the
284
:param lossy: When committing to a foreign VCS, ignore any
285
data that can not be natively represented.
287
operation = OperationWithCleanups(self._commit)
288
self.revprops = revprops or {}
289
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
290
self.config_stack = config or self.config_stack
291
return operation.run(
296
specific_files=specific_files,
298
allow_pointless=allow_pointless,
301
working_tree=working_tree,
304
message_callback=message_callback,
307
possible_master_transports=possible_master_transports,
310
def _commit(self, operation, message, timestamp, timezone, committer,
311
specific_files, rev_id, allow_pointless, strict, verbose,
312
working_tree, local, reporter, message_callback, recursive,
313
exclude, possible_master_transports, lossy):
314
mutter('preparing to commit')
316
if working_tree is None:
317
raise BzrError("working_tree must be passed into commit().")
319
self.work_tree = working_tree
320
self.branch = self.work_tree.branch
321
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
322
if not self.branch.repository.supports_rich_root():
323
raise errors.RootNotRich()
324
if message_callback is None:
325
if message is not None:
326
if isinstance(message, bytes):
327
message = message.decode(get_user_encoding())
328
message_callback = lambda x: message
330
raise BzrError("The message or message_callback keyword"
331
" parameter is required for commit().")
333
self.bound_branch = None
334
self.any_entries_deleted = False
335
if exclude is not None:
336
self.exclude = sorted(
337
minimum_path_selection(exclude))
341
self.master_branch = None
342
self.recursive = recursive
344
# self.specific_files is None to indicate no filter, or any iterable to
345
# indicate a filter - [] means no files at all, as per iter_changes.
346
if specific_files is not None:
347
self.specific_files = sorted(
348
minimum_path_selection(specific_files))
350
self.specific_files = None
352
self.allow_pointless = allow_pointless
353
self.message_callback = message_callback
354
self.timestamp = timestamp
355
self.timezone = timezone
356
self.committer = committer
358
self.verbose = verbose
360
self.work_tree.lock_write()
361
operation.add_cleanup(self.work_tree.unlock)
362
self.parents = self.work_tree.get_parent_ids()
363
self.pb = ui.ui_factory.nested_progress_bar()
364
operation.add_cleanup(self.pb.finished)
365
self.basis_revid = self.work_tree.last_revision()
366
self.basis_tree = self.work_tree.basis_tree()
367
self.basis_tree.lock_read()
368
operation.add_cleanup(self.basis_tree.unlock)
369
# Cannot commit with conflicts present.
370
if len(self.work_tree.conflicts()) > 0:
371
raise ConflictsInTree
373
# Setup the bound branch variables as needed.
374
self._check_bound_branch(operation, possible_master_transports)
376
# Check that the working tree is up to date
377
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
379
# Complete configuration setup
380
if reporter is not None:
381
self.reporter = reporter
382
elif self.reporter is None:
383
self.reporter = self._select_reporter()
384
if self.config_stack is None:
385
self.config_stack = self.work_tree.get_config_stack()
387
# Setup the progress bar. As the number of files that need to be
388
# committed in unknown, progress is reported as stages.
389
# We keep track of entries separately though and include that
390
# information in the progress bar during the relevant stages.
391
self.pb_stage_name = ""
392
self.pb_stage_count = 0
393
self.pb_stage_total = 5
394
if self.bound_branch:
395
# 2 extra stages: "Uploading data to master branch" and "Merging
396
# tags to master branch"
397
self.pb_stage_total += 2
398
self.pb.show_pct = False
399
self.pb.show_spinner = False
400
self.pb.show_eta = False
401
self.pb.show_count = True
402
self.pb.show_bar = True
404
# After a merge, a selected file commit is not supported.
405
# See 'bzr help merge' for an explanation as to why.
406
if len(self.parents) > 1 and self.specific_files is not None:
407
raise CannotCommitSelectedFileMerge(self.specific_files)
408
# Excludes are a form of selected file commit.
409
if len(self.parents) > 1 and self.exclude:
410
raise CannotCommitSelectedFileMerge(self.exclude)
412
# Collect the changes
413
self._set_progress_stage("Collecting changes", counter=True)
415
self.builder = self.branch.get_commit_builder(self.parents,
416
self.config_stack, timestamp, timezone, committer, self.revprops,
419
if self.builder.updates_branch and self.bound_branch:
421
raise AssertionError(
422
"bound branches not supported for commit builders "
423
"that update the branch")
426
# find the location being committed to
427
if self.bound_branch:
428
master_location = self.master_branch.base
430
master_location = self.branch.base
432
# report the start of the commit
433
self.reporter.started(new_revno, self.rev_id, master_location)
435
self._update_builder_with_changes()
436
self._check_pointless()
438
# TODO: Now the new inventory is known, check for conflicts.
439
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
440
# weave lines, because nothing should be recorded until it is known
441
# that commit will succeed.
442
self._set_progress_stage("Saving data locally")
443
self.builder.finish_inventory()
445
# Prompt the user for a commit message if none provided
446
message = message_callback(self)
447
self.message = message
449
# Add revision data to the local branch
450
self.rev_id = self.builder.commit(self.message)
452
except Exception as e:
453
mutter("aborting commit write group because of exception:")
454
trace.log_exception_quietly()
458
self._update_branches(old_revno, old_revid, new_revno)
460
# Make the working tree be up to date with the branch. This
461
# includes automatic changes scheduled to be made to the tree, such
462
# as updating its basis and unversioning paths that were missing.
463
self.work_tree.unversion(
464
{self.work_tree.id2path(file_id) for file_id in self.deleted_ids},
466
self._set_progress_stage("Updating the working tree")
467
self.work_tree.update_basis_by_delta(self.rev_id,
468
self.builder.get_basis_delta())
469
self.reporter.completed(new_revno, self.rev_id)
470
self._process_post_hooks(old_revno, new_revno)
473
def _update_branches(self, old_revno, old_revid, new_revno):
474
"""Update the master and local branch to the new revision.
476
This will try to make sure that the master branch is updated
477
before the local branch.
479
:param old_revno: Revision number of master branch before the
481
:param old_revid: Tip of master branch before the commit
482
:param new_revno: Revision number of the new commit
484
if not self.builder.updates_branch:
485
self._process_pre_hooks(old_revno, new_revno)
487
# Upload revision data to the master.
488
# this will propagate merged revisions too if needed.
489
if self.bound_branch:
490
self._set_progress_stage("Uploading data to master branch")
491
# 'commit' to the master first so a timeout here causes the
492
# local branch to be out of date
493
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
494
self.branch, new_revno, self.rev_id, lossy=self._lossy)
496
self.branch.fetch(self.master_branch, self.rev_id)
498
# and now do the commit locally.
499
self.branch.set_last_revision_info(new_revno, self.rev_id)
502
self._process_pre_hooks(old_revno, new_revno)
504
# The commit builder will already have updated the branch,
506
self.branch.set_last_revision_info(old_revno, old_revid)
509
# Merge local tags to remote
510
if self.bound_branch:
511
self._set_progress_stage("Merging tags to master branch")
512
tag_updates, tag_conflicts = self.branch.tags.merge_to(
513
self.master_branch.tags)
515
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
516
note( gettext("Conflicting tags in bound branch:\n{0}".format(
517
"\n".join(warning_lines))) )
519
def _select_reporter(self):
520
"""Select the CommitReporter to use."""
522
return NullCommitReporter()
523
return ReportCommitToLog()
525
def _check_pointless(self):
526
if self.allow_pointless:
528
# A merge with no effect on files
529
if len(self.parents) > 1:
531
if self.builder.any_changes():
533
raise PointlessCommit()
535
def _check_bound_branch(self, operation, possible_master_transports=None):
536
"""Check to see if the local branch is bound.
538
If it is bound, then most of the commit will actually be
539
done using the remote branch as the target branch.
540
Only at the end will the local branch be updated.
542
if self.local and not self.branch.get_bound_location():
543
raise errors.LocalRequiresBoundBranch()
546
self.master_branch = self.branch.get_master_branch(
547
possible_master_transports)
549
if not self.master_branch:
550
# make this branch the reference branch for out of date checks.
551
self.master_branch = self.branch
554
# If the master branch is bound, we must fail
555
master_bound_location = self.master_branch.get_bound_location()
556
if master_bound_location:
557
raise errors.CommitToDoubleBoundBranch(self.branch,
558
self.master_branch, master_bound_location)
560
# TODO: jam 20051230 We could automatically push local
561
# commits to the remote branch if they would fit.
562
# But for now, just require remote to be identical
565
# Make sure the local branch is identical to the master
566
master_info = self.master_branch.last_revision_info()
567
local_info = self.branch.last_revision_info()
568
if local_info != master_info:
569
raise errors.BoundBranchOutOfDate(self.branch,
572
# Now things are ready to change the master branch
574
self.bound_branch = self.branch
575
self.master_branch.lock_write()
576
operation.add_cleanup(self.master_branch.unlock)
578
def _check_out_of_date_tree(self):
579
"""Check that the working tree is up to date.
581
:return: old_revision_number, old_revision_id, new_revision_number
585
first_tree_parent = self.work_tree.get_parent_ids()[0]
587
# if there are no parents, treat our parent as 'None'
588
# this is so that we still consider the master branch
589
# - in a checkout scenario the tree may have no
590
# parents but the branch may do.
591
first_tree_parent = breezy.revision.NULL_REVISION
592
old_revno, master_last = self.master_branch.last_revision_info()
593
if master_last != first_tree_parent:
594
if master_last != breezy.revision.NULL_REVISION:
595
raise errors.OutOfDateTree(self.work_tree)
596
if self.branch.repository.has_revision(first_tree_parent):
597
new_revno = old_revno + 1
599
# ghost parents never appear in revision history.
601
return old_revno, master_last, new_revno
603
def _process_pre_hooks(self, old_revno, new_revno):
604
"""Process any registered pre commit hooks."""
605
self._set_progress_stage("Running pre_commit hooks")
606
self._process_hooks("pre_commit", old_revno, new_revno)
608
def _process_post_hooks(self, old_revno, new_revno):
609
"""Process any registered post commit hooks."""
610
# Process the post commit hooks, if any
611
self._set_progress_stage("Running post_commit hooks")
612
# old style commit hooks - should be deprecated ? (obsoleted in
613
# 0.15^H^H^H^H 2.5.0)
614
post_commit = self.config_stack.get('post_commit')
615
if post_commit is not None:
616
hooks = post_commit.split(' ')
617
# this would be nicer with twisted.python.reflect.namedAny
619
result = eval(hook + '(branch, rev_id)',
620
{'branch':self.branch,
622
'rev_id':self.rev_id})
623
# process new style post commit hooks
624
self._process_hooks("post_commit", old_revno, new_revno)
626
def _process_hooks(self, hook_name, old_revno, new_revno):
627
if not Branch.hooks[hook_name]:
630
# new style commit hooks:
631
if not self.bound_branch:
632
hook_master = self.branch
635
hook_master = self.master_branch
636
hook_local = self.branch
637
# With bound branches, when the master is behind the local branch,
638
# the 'old_revno' and old_revid values here are incorrect.
639
# XXX: FIXME ^. RBC 20060206
641
old_revid = self.parents[0]
643
old_revid = breezy.revision.NULL_REVISION
645
if hook_name == "pre_commit":
646
future_tree = self.builder.revision_tree()
647
tree_delta = future_tree.changes_from(self.basis_tree,
650
for hook in Branch.hooks[hook_name]:
651
# show the running hook in the progress bar. As hooks may
652
# end up doing nothing (e.g. because they are not configured by
653
# the user) this is still showing progress, not showing overall
654
# actions - its up to each plugin to show a UI if it want's to
655
# (such as 'Emailing diff to foo@example.com').
656
self.pb_stage_name = "Running %s hooks [%s]" % \
657
(hook_name, Branch.hooks.get_hook_name(hook))
658
self._emit_progress()
659
if 'hooks' in debug.debug_flags:
660
mutter("Invoking commit hook: %r", hook)
661
if hook_name == "post_commit":
662
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
664
elif hook_name == "pre_commit":
665
hook(hook_local, hook_master,
666
old_revno, old_revid, new_revno, self.rev_id,
667
tree_delta, future_tree)
669
def _update_builder_with_changes(self):
670
"""Update the commit builder with the data about what has changed.
672
specific_files = self.specific_files
673
mutter("Selecting files for commit with filter %r", specific_files)
676
iter_changes = self.work_tree.iter_changes(self.basis_tree,
677
specific_files=specific_files)
679
iter_changes = filter_excluded(iter_changes, self.exclude)
680
iter_changes = self._filter_iter_changes(iter_changes)
681
for file_id, path, fs_hash in self.builder.record_iter_changes(
682
self.work_tree, self.basis_revid, iter_changes):
683
self.work_tree._observed_sha1(file_id, path, fs_hash)
685
def _filter_iter_changes(self, iter_changes):
686
"""Process iter_changes.
688
This method reports on the changes in iter_changes to the user, and
689
converts 'missing' entries in the iter_changes iterator to 'deleted'
690
entries. 'missing' entries have their
692
:param iter_changes: An iter_changes to process.
693
:return: A generator of changes.
695
reporter = self.reporter
696
report_changes = reporter.is_verbose()
698
for change in iter_changes:
700
old_path = change[1][0]
701
new_path = change[1][1]
702
versioned = change[3][1]
704
versioned = change[3][1]
705
if kind is None and versioned:
708
reporter.missing(new_path)
709
deleted_ids.append(change[0])
710
# Reset the new path (None) and new versioned flag (False)
711
change = (change[0], (change[1][0], None), change[2],
712
(change[3][0], False)) + change[4:]
713
new_path = change[1][1]
715
elif kind == 'tree-reference':
716
if self.recursive == 'down':
717
self._commit_nested_tree(change[0], change[1][1])
718
if change[3][0] or change[3][1]:
722
reporter.deleted(old_path)
723
elif old_path is None:
724
reporter.snapshot_change(gettext('added'), new_path)
725
elif old_path != new_path:
726
reporter.renamed(gettext('renamed'), old_path, new_path)
729
self.work_tree.branch.repository._format.rich_root_data):
730
# Don't report on changes to '' in non rich root
732
reporter.snapshot_change(gettext('modified'), new_path)
733
self._next_progress_entry()
734
# Unversion IDs that were found to be deleted
735
self.deleted_ids = deleted_ids
737
def _check_strict(self):
738
# XXX: when we use iter_changes this would likely be faster if
739
# iter_changes would check for us (even in the presence of
742
# raise an exception as soon as we find a single unknown.
743
for unknown in self.work_tree.unknowns():
744
raise StrictCommitFailed()
746
def _commit_nested_tree(self, file_id, path):
747
"Commit a nested tree."
748
sub_tree = self.work_tree.get_nested_tree(path, file_id)
749
# FIXME: be more comprehensive here:
750
# this works when both trees are in --trees repository,
751
# but when both are bound to a different repository,
752
# it fails; a better way of approaching this is to
753
# finally implement the explicit-caches approach design
754
# a while back - RBC 20070306.
755
if sub_tree.branch.repository.has_same_location(
756
self.work_tree.branch.repository):
757
sub_tree.branch.repository = \
758
self.work_tree.branch.repository
760
return sub_tree.commit(message=None, revprops=self.revprops,
761
recursive=self.recursive,
762
message_callback=self.message_callback,
763
timestamp=self.timestamp, timezone=self.timezone,
764
committer=self.committer,
765
allow_pointless=self.allow_pointless,
766
strict=self.strict, verbose=self.verbose,
767
local=self.local, reporter=self.reporter)
768
except PointlessCommit:
769
return self.work_tree.get_reference_revision(path, file_id)
771
def _set_progress_stage(self, name, counter=False):
772
"""Set the progress stage and emit an update to the progress bar."""
773
self.pb_stage_name = name
774
self.pb_stage_count += 1
776
self.pb_entries_count = 0
778
self.pb_entries_count = None
779
self._emit_progress()
781
def _next_progress_entry(self):
782
"""Emit an update to the progress bar and increment the entry count."""
783
self.pb_entries_count += 1
784
self._emit_progress()
786
def _emit_progress(self):
787
if self.pb_entries_count is not None:
788
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
789
self.pb_entries_count)
791
text = gettext("%s - Stage") % (self.pb_stage_name, )
792
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
breezy/commit.py
