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(self.deleted_paths)
464
self._set_progress_stage("Updating the working tree")
465
self.work_tree.update_basis_by_delta(self.rev_id,
466
self.builder.get_basis_delta())
467
self.reporter.completed(new_revno, self.rev_id)
468
self._process_post_hooks(old_revno, new_revno)
471
def _update_branches(self, old_revno, old_revid, new_revno):
472
"""Update the master and local branch to the new revision.
474
This will try to make sure that the master branch is updated
475
before the local branch.
477
:param old_revno: Revision number of master branch before the
479
:param old_revid: Tip of master branch before the commit
480
:param new_revno: Revision number of the new commit
482
if not self.builder.updates_branch:
483
self._process_pre_hooks(old_revno, new_revno)
485
# Upload revision data to the master.
486
# this will propagate merged revisions too if needed.
487
if self.bound_branch:
488
self._set_progress_stage("Uploading data to master branch")
489
# 'commit' to the master first so a timeout here causes the
490
# local branch to be out of date
491
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
492
self.branch, new_revno, self.rev_id, lossy=self._lossy)
494
self.branch.fetch(self.master_branch, self.rev_id)
496
# and now do the commit locally.
497
self.branch.set_last_revision_info(new_revno, self.rev_id)
500
self._process_pre_hooks(old_revno, new_revno)
502
# The commit builder will already have updated the branch,
504
self.branch.set_last_revision_info(old_revno, old_revid)
507
# Merge local tags to remote
508
if self.bound_branch:
509
self._set_progress_stage("Merging tags to master branch")
510
tag_updates, tag_conflicts = self.branch.tags.merge_to(
511
self.master_branch.tags)
513
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
514
note( gettext("Conflicting tags in bound branch:\n{0}".format(
515
"\n".join(warning_lines))) )
517
def _select_reporter(self):
518
"""Select the CommitReporter to use."""
520
return NullCommitReporter()
521
return ReportCommitToLog()
523
def _check_pointless(self):
524
if self.allow_pointless:
526
# A merge with no effect on files
527
if len(self.parents) > 1:
529
if self.builder.any_changes():
531
raise PointlessCommit()
533
def _check_bound_branch(self, operation, possible_master_transports=None):
534
"""Check to see if the local branch is bound.
536
If it is bound, then most of the commit will actually be
537
done using the remote branch as the target branch.
538
Only at the end will the local branch be updated.
540
if self.local and not self.branch.get_bound_location():
541
raise errors.LocalRequiresBoundBranch()
544
self.master_branch = self.branch.get_master_branch(
545
possible_master_transports)
547
if not self.master_branch:
548
# make this branch the reference branch for out of date checks.
549
self.master_branch = self.branch
552
# If the master branch is bound, we must fail
553
master_bound_location = self.master_branch.get_bound_location()
554
if master_bound_location:
555
raise errors.CommitToDoubleBoundBranch(self.branch,
556
self.master_branch, master_bound_location)
558
# TODO: jam 20051230 We could automatically push local
559
# commits to the remote branch if they would fit.
560
# But for now, just require remote to be identical
563
# Make sure the local branch is identical to the master
564
master_info = self.master_branch.last_revision_info()
565
local_info = self.branch.last_revision_info()
566
if local_info != master_info:
567
raise errors.BoundBranchOutOfDate(self.branch,
570
# Now things are ready to change the master branch
572
self.bound_branch = self.branch
573
self.master_branch.lock_write()
574
operation.add_cleanup(self.master_branch.unlock)
576
def _check_out_of_date_tree(self):
577
"""Check that the working tree is up to date.
579
:return: old_revision_number, old_revision_id, new_revision_number
583
first_tree_parent = self.work_tree.get_parent_ids()[0]
585
# if there are no parents, treat our parent as 'None'
586
# this is so that we still consider the master branch
587
# - in a checkout scenario the tree may have no
588
# parents but the branch may do.
589
first_tree_parent = breezy.revision.NULL_REVISION
590
old_revno, master_last = self.master_branch.last_revision_info()
591
if master_last != first_tree_parent:
592
if master_last != breezy.revision.NULL_REVISION:
593
raise errors.OutOfDateTree(self.work_tree)
594
if self.branch.repository.has_revision(first_tree_parent):
595
new_revno = old_revno + 1
597
# ghost parents never appear in revision history.
599
return old_revno, master_last, new_revno
601
def _process_pre_hooks(self, old_revno, new_revno):
602
"""Process any registered pre commit hooks."""
603
self._set_progress_stage("Running pre_commit hooks")
604
self._process_hooks("pre_commit", old_revno, new_revno)
606
def _process_post_hooks(self, old_revno, new_revno):
607
"""Process any registered post commit hooks."""
608
# Process the post commit hooks, if any
609
self._set_progress_stage("Running post_commit hooks")
610
# old style commit hooks - should be deprecated ? (obsoleted in
611
# 0.15^H^H^H^H 2.5.0)
612
post_commit = self.config_stack.get('post_commit')
613
if post_commit is not None:
614
hooks = post_commit.split(' ')
615
# this would be nicer with twisted.python.reflect.namedAny
617
result = eval(hook + '(branch, rev_id)',
618
{'branch':self.branch,
620
'rev_id':self.rev_id})
621
# process new style post commit hooks
622
self._process_hooks("post_commit", old_revno, new_revno)
624
def _process_hooks(self, hook_name, old_revno, new_revno):
625
if not Branch.hooks[hook_name]:
628
# new style commit hooks:
629
if not self.bound_branch:
630
hook_master = self.branch
633
hook_master = self.master_branch
634
hook_local = self.branch
635
# With bound branches, when the master is behind the local branch,
636
# the 'old_revno' and old_revid values here are incorrect.
637
# XXX: FIXME ^. RBC 20060206
639
old_revid = self.parents[0]
641
old_revid = breezy.revision.NULL_REVISION
643
if hook_name == "pre_commit":
644
future_tree = self.builder.revision_tree()
645
tree_delta = future_tree.changes_from(self.basis_tree,
648
for hook in Branch.hooks[hook_name]:
649
# show the running hook in the progress bar. As hooks may
650
# end up doing nothing (e.g. because they are not configured by
651
# the user) this is still showing progress, not showing overall
652
# actions - its up to each plugin to show a UI if it want's to
653
# (such as 'Emailing diff to foo@example.com').
654
self.pb_stage_name = "Running %s hooks [%s]" % \
655
(hook_name, Branch.hooks.get_hook_name(hook))
656
self._emit_progress()
657
if 'hooks' in debug.debug_flags:
658
mutter("Invoking commit hook: %r", hook)
659
if hook_name == "post_commit":
660
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
662
elif hook_name == "pre_commit":
663
hook(hook_local, hook_master,
664
old_revno, old_revid, new_revno, self.rev_id,
665
tree_delta, future_tree)
667
def _update_builder_with_changes(self):
668
"""Update the commit builder with the data about what has changed.
670
specific_files = self.specific_files
671
mutter("Selecting files for commit with filter %r", specific_files)
674
iter_changes = self.work_tree.iter_changes(self.basis_tree,
675
specific_files=specific_files)
677
iter_changes = filter_excluded(iter_changes, self.exclude)
678
iter_changes = self._filter_iter_changes(iter_changes)
679
for file_id, path, fs_hash in self.builder.record_iter_changes(
680
self.work_tree, self.basis_revid, iter_changes):
681
self.work_tree._observed_sha1(file_id, path, fs_hash)
683
def _filter_iter_changes(self, iter_changes):
684
"""Process iter_changes.
686
This method reports on the changes in iter_changes to the user, and
687
converts 'missing' entries in the iter_changes iterator to 'deleted'
688
entries. 'missing' entries have their
690
:param iter_changes: An iter_changes to process.
691
:return: A generator of changes.
693
reporter = self.reporter
694
report_changes = reporter.is_verbose()
696
for change in iter_changes:
698
old_path = change[1][0]
699
new_path = change[1][1]
700
versioned = change[3][1]
702
versioned = change[3][1]
703
if kind is None and versioned:
706
reporter.missing(new_path)
707
deleted_paths.append(change[1][1])
708
# Reset the new path (None) and new versioned flag (False)
709
change = (change[0], (change[1][0], None), change[2],
710
(change[3][0], False)) + change[4:]
711
new_path = change[1][1]
713
elif kind == 'tree-reference':
714
if self.recursive == 'down':
715
self._commit_nested_tree(change[0], change[1][1])
716
if change[3][0] or change[3][1]:
720
reporter.deleted(old_path)
721
elif old_path is None:
722
reporter.snapshot_change(gettext('added'), new_path)
723
elif old_path != new_path:
724
reporter.renamed(gettext('renamed'), old_path, new_path)
727
self.work_tree.branch.repository._format.rich_root_data):
728
# Don't report on changes to '' in non rich root
730
reporter.snapshot_change(gettext('modified'), new_path)
731
self._next_progress_entry()
732
# Unversion files that were found to be deleted
733
self.deleted_paths = deleted_paths
735
def _check_strict(self):
736
# XXX: when we use iter_changes this would likely be faster if
737
# iter_changes would check for us (even in the presence of
740
# raise an exception as soon as we find a single unknown.
741
for unknown in self.work_tree.unknowns():
742
raise StrictCommitFailed()
744
def _commit_nested_tree(self, file_id, path):
745
"Commit a nested tree."
746
sub_tree = self.work_tree.get_nested_tree(path, file_id)
747
# FIXME: be more comprehensive here:
748
# this works when both trees are in --trees repository,
749
# but when both are bound to a different repository,
750
# it fails; a better way of approaching this is to
751
# finally implement the explicit-caches approach design
752
# a while back - RBC 20070306.
753
if sub_tree.branch.repository.has_same_location(
754
self.work_tree.branch.repository):
755
sub_tree.branch.repository = \
756
self.work_tree.branch.repository
758
return sub_tree.commit(message=None, revprops=self.revprops,
759
recursive=self.recursive,
760
message_callback=self.message_callback,
761
timestamp=self.timestamp, timezone=self.timezone,
762
committer=self.committer,
763
allow_pointless=self.allow_pointless,
764
strict=self.strict, verbose=self.verbose,
765
local=self.local, reporter=self.reporter)
766
except PointlessCommit:
767
return self.work_tree.get_reference_revision(path, file_id)
769
def _set_progress_stage(self, name, counter=False):
770
"""Set the progress stage and emit an update to the progress bar."""
771
self.pb_stage_name = name
772
self.pb_stage_count += 1
774
self.pb_entries_count = 0
776
self.pb_entries_count = None
777
self._emit_progress()
779
def _next_progress_entry(self):
780
"""Emit an update to the progress bar and increment the entry count."""
781
self.pb_entries_count += 1
782
self._emit_progress()
784
def _emit_progress(self):
785
if self.pb_entries_count is not None:
786
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
787
self.pb_entries_count)
789
text = gettext("%s - Stage") % (self.pb_stage_name, )
790
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
breezy/commit.py
