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
# The newly committed revision is going to have a shape corresponding
18
# to that of the working tree. Files that are not in the
19
# working tree and that were in the predecessor are reported as
20
# removed --- this can include files that were either removed from the
21
# inventory or deleted in the working tree. If they were only
22
# deleted from disk, they are removed from the working inventory.
24
# We then consider the remaining entries, which will be in the new
25
# version. Directory entries are simply copied across. File entries
26
# must be checked to see if a new version of the file should be
27
# recorded. For each parent revision tree, we check to see what
28
# version of the file was present. If the file was present in at
29
# least one tree, and if it was the same version in all the trees,
30
# then we can just refer to that version. Otherwise, a new version
31
# representing the merger of the file versions must be added.
33
# TODO: Update hashcache before and after - or does the WorkingTree
36
# TODO: Rather than mashing together the ancestry and storing it back,
37
# perhaps the weave should have single method which does it all in one
38
# go, avoiding a lot of redundant work.
40
# TODO: Perhaps give a warning if one of the revisions marked as
41
# merged is already in the ancestry, and then don't record it as a
44
# TODO: If the file is newly merged but unchanged from the version it
45
# merges from, then it should still be reported as newly added
46
# relative to the basis revision.
48
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
49
# the rest of the code; add a deprecation of the old name.
57
from .branch import Branch
58
from contextlib import ExitStack
60
from .errors import (BzrError,
64
from .osutils import (get_user_encoding,
67
minimum_path_selection,
69
from .trace import mutter, note, is_quiet
70
from .tree import TreeChange
71
from .urlutils import unescape_for_display
72
from .i18n import gettext
75
class PointlessCommit(BzrError):
77
_fmt = "No changes to commit"
80
class CannotCommitSelectedFileMerge(BzrError):
82
_fmt = 'Selected-file commit of merges is not supported yet:'\
83
' files %(files_str)s'
85
def __init__(self, files):
86
files_str = ', '.join(files)
87
BzrError.__init__(self, files=files, files_str=files_str)
90
def filter_excluded(iter_changes, exclude):
91
"""Filter exclude filenames.
93
:param iter_changes: iter_changes function
94
:param exclude: List of paths to exclude
95
:return: iter_changes function
97
for change in iter_changes:
98
new_excluded = (change.path[1] is not None and
99
is_inside_any(exclude, change.path[1]))
101
old_excluded = (change.path[0] is not None and
102
is_inside_any(exclude, change.path[0]))
104
if old_excluded and new_excluded:
107
if old_excluded or new_excluded:
108
# TODO(jelmer): Perhaps raise an error here instead?
114
class NullCommitReporter(object):
115
"""I report on progress of a commit."""
117
def started(self, revno, revid, location):
120
def snapshot_change(self, change, path):
123
def completed(self, revno, rev_id):
126
def deleted(self, path):
129
def missing(self, path):
132
def renamed(self, change, old_path, new_path):
135
def is_verbose(self):
139
class ReportCommitToLog(NullCommitReporter):
141
def _note(self, format, *args):
144
Subclasses may choose to override this method.
148
def snapshot_change(self, change, path):
149
if path == '' and change in (gettext('added'), gettext('modified')):
151
self._note("%s %s", change, path)
153
def started(self, revno, rev_id, location):
155
gettext('Committing to: %s'),
156
unescape_for_display(location, 'utf-8'))
158
def completed(self, revno, rev_id):
159
if revno is not None:
160
self._note(gettext('Committed revision %d.'), revno)
161
# self._note goes to the console too; so while we want to log the
162
# rev_id, we can't trivially only log it. (See bug 526425). Long
163
# term we should rearrange the reporting structure, but for now
164
# we just mutter seperately. We mutter the revid and revno together
165
# so that concurrent bzr invocations won't lead to confusion.
166
mutter('Committed revid %s as revno %d.', rev_id, revno)
168
self._note(gettext('Committed revid %s.'), rev_id)
170
def deleted(self, path):
171
self._note(gettext('deleted %s'), path)
173
def missing(self, path):
174
self._note(gettext('missing %s'), path)
176
def renamed(self, change, old_path, new_path):
177
self._note('%s %s => %s', change, old_path, new_path)
179
def is_verbose(self):
183
class Commit(object):
184
"""Task of committing a new revision.
186
This is a MethodObject: it accumulates state as the commit is
187
prepared, and then it is discarded. It doesn't represent
188
historical revisions, just the act of recording a new one.
191
Modified to hold a list of files that have been deleted from
192
the working directory; these should be removed from the
199
"""Create a Commit object.
201
:param reporter: the default reporter to use or None to decide later
203
self.reporter = reporter
204
self.config_stack = config_stack
207
def update_revprops(revprops, branch, authors=None,
208
local=False, possible_master_transports=None):
211
if possible_master_transports is None:
212
possible_master_transports = []
213
if (u'branch-nick' not in revprops and
214
branch.repository._format.supports_storing_branch_nick):
215
revprops[u'branch-nick'] = branch._get_nick(
217
possible_master_transports)
218
if authors is not None:
219
if u'author' in revprops or u'authors' in revprops:
220
# XXX: maybe we should just accept one of them?
221
raise AssertionError('author property given twice')
223
for individual in authors:
224
if '\n' in individual:
225
raise AssertionError('\\n is not a valid character '
226
'in an author identity')
227
revprops[u'authors'] = '\n'.join(authors)
237
allow_pointless=True,
245
message_callback=None,
248
possible_master_transports=None,
250
"""Commit working copy as a new revision.
252
:param message: the commit message (it or message_callback is required)
253
:param message_callback: A callback: message =
254
message_callback(cmt_obj)
256
:param timestamp: if not None, seconds-since-epoch for a
257
postdated/predated commit.
259
:param specific_files: If not None, commit only those files. An empty
260
list means 'commit no files'.
262
:param rev_id: If set, use this as the new revision id.
263
Useful for test or import commands that need to tightly
264
control what revisions are assigned. If you duplicate
265
a revision id that exists elsewhere it is your own fault.
266
If null (default), a time/random revision id is generated.
268
:param allow_pointless: If true (default), commit even if nothing
269
has changed and no merges are recorded.
271
:param strict: If true, don't allow a commit if the working tree
272
contains unknown files.
274
:param revprops: Properties for new revision
275
:param local: Perform a local only commit.
276
:param reporter: the reporter to use or None for the default
277
:param verbose: if True and the reporter is not None, report everything
278
:param recursive: If set to 'down', commit in any subtrees that have
279
pending changes of any sort during this commit.
280
:param exclude: None or a list of relative paths to exclude from the
281
commit. Pending changes to excluded files will be ignored by the
283
:param lossy: When committing to a foreign VCS, ignore any
284
data that can not be natively represented.
286
with ExitStack() as stack:
287
self.revprops = revprops or {}
288
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
self.config_stack = config or self.config_stack
290
mutter('preparing to commit')
292
if working_tree is None:
293
raise BzrError("working_tree must be passed into commit().")
295
self.work_tree = working_tree
296
self.branch = self.work_tree.branch
297
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
298
if not self.branch.repository.supports_rich_root():
299
raise errors.RootNotRich()
300
if message_callback is None:
301
if message is not None:
302
if isinstance(message, bytes):
303
message = message.decode(get_user_encoding())
305
def message_callback(x):
308
raise BzrError("The message or message_callback keyword"
309
" parameter is required for commit().")
311
self.bound_branch = None
312
self.any_entries_deleted = False
313
if exclude is not None:
314
self.exclude = sorted(
315
minimum_path_selection(exclude))
319
self.master_branch = None
320
self.recursive = recursive
322
# self.specific_files is None to indicate no filter, or any iterable to
323
# indicate a filter - [] means no files at all, as per iter_changes.
324
if specific_files is not None:
325
self.specific_files = sorted(
326
minimum_path_selection(specific_files))
328
self.specific_files = None
330
self.allow_pointless = allow_pointless
331
self.message_callback = message_callback
332
self.timestamp = timestamp
333
self.timezone = timezone
334
self.committer = committer
336
self.verbose = verbose
338
stack.enter_context(self.work_tree.lock_write())
339
self.parents = self.work_tree.get_parent_ids()
340
self.pb = ui.ui_factory.nested_progress_bar()
341
stack.callback(self.pb.finished)
342
self.basis_revid = self.work_tree.last_revision()
343
self.basis_tree = self.work_tree.basis_tree()
344
stack.enter_context(self.basis_tree.lock_read())
345
# Cannot commit with conflicts present.
346
if len(self.work_tree.conflicts()) > 0:
347
raise ConflictsInTree
349
# Setup the bound branch variables as needed.
350
self._check_bound_branch(stack, possible_master_transports)
351
if self.config_stack is None:
352
self.config_stack = self.work_tree.get_config_stack()
354
# Check that the working tree is up to date
355
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
357
# Complete configuration setup
358
if reporter is not None:
359
self.reporter = reporter
360
elif self.reporter is None:
361
self.reporter = self._select_reporter()
363
# Setup the progress bar. As the number of files that need to be
364
# committed in unknown, progress is reported as stages.
365
# We keep track of entries separately though and include that
366
# information in the progress bar during the relevant stages.
367
self.pb_stage_name = ""
368
self.pb_stage_count = 0
369
self.pb_stage_total = 5
370
if self.bound_branch:
371
# 2 extra stages: "Uploading data to master branch" and "Merging
372
# tags to master branch"
373
self.pb_stage_total += 2
374
self.pb.show_pct = False
375
self.pb.show_spinner = False
376
self.pb.show_eta = False
377
self.pb.show_count = True
378
self.pb.show_bar = True
380
# After a merge, a selected file commit is not supported.
381
# See 'bzr help merge' for an explanation as to why.
382
if len(self.parents) > 1 and self.specific_files is not None:
383
raise CannotCommitSelectedFileMerge(self.specific_files)
384
# Excludes are a form of selected file commit.
385
if len(self.parents) > 1 and self.exclude:
386
raise CannotCommitSelectedFileMerge(self.exclude)
388
# Collect the changes
389
self._set_progress_stage("Collecting changes", counter=True)
391
self.builder = self.branch.get_commit_builder(
392
self.parents, self.config_stack, timestamp, timezone, committer,
393
self.revprops, rev_id, lossy=lossy)
395
if self.builder.updates_branch and self.bound_branch:
397
raise AssertionError(
398
"bound branches not supported for commit builders "
399
"that update the branch")
402
# find the location being committed to
403
if self.bound_branch:
404
master_location = self.master_branch.base
406
master_location = self.branch.base
408
# report the start of the commit
409
self.reporter.started(new_revno, self.rev_id, master_location)
411
self._update_builder_with_changes()
412
self._check_pointless()
414
# TODO: Now the new inventory is known, check for conflicts.
415
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
416
# weave lines, because nothing should be recorded until it is known
417
# that commit will succeed.
418
self._set_progress_stage("Saving data locally")
419
self.builder.finish_inventory()
421
# Prompt the user for a commit message if none provided
422
message = message_callback(self)
423
self.message = message
425
# Add revision data to the local branch
426
self.rev_id = self.builder.commit(self.message)
429
mutter("aborting commit write group because of exception:")
430
trace.log_exception_quietly()
434
self._update_branches(old_revno, old_revid, new_revno)
436
# Make the working tree be up to date with the branch. This
437
# includes automatic changes scheduled to be made to the tree, such
438
# as updating its basis and unversioning paths that were missing.
439
self.work_tree.unversion(self.deleted_paths)
440
self._set_progress_stage("Updating the working tree")
441
self.work_tree.update_basis_by_delta(
442
self.rev_id, self.builder.get_basis_delta())
443
self.reporter.completed(new_revno, self.rev_id)
444
self._process_post_hooks(old_revno, new_revno)
447
def _update_branches(self, old_revno, old_revid, new_revno):
448
"""Update the master and local branch to the new revision.
450
This will try to make sure that the master branch is updated
451
before the local branch.
453
:param old_revno: Revision number of master branch before the
455
:param old_revid: Tip of master branch before the commit
456
:param new_revno: Revision number of the new commit
458
if not self.builder.updates_branch:
459
self._process_pre_hooks(old_revno, new_revno)
461
# Upload revision data to the master.
462
# this will propagate merged revisions too if needed.
463
if self.bound_branch:
464
self._set_progress_stage("Uploading data to master branch")
465
# 'commit' to the master first so a timeout here causes the
466
# local branch to be out of date
467
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
468
self.branch, new_revno, self.rev_id, lossy=self._lossy)
470
self.branch.fetch(self.master_branch, self.rev_id)
472
# and now do the commit locally.
473
if new_revno is None:
474
# Keep existing behaviour around ghosts
476
self.branch.set_last_revision_info(new_revno, self.rev_id)
479
self._process_pre_hooks(old_revno, new_revno)
480
except BaseException:
481
# The commit builder will already have updated the branch,
483
self.branch.set_last_revision_info(old_revno, old_revid)
486
# Merge local tags to remote
487
if self.bound_branch:
488
self._set_progress_stage("Merging tags to master branch")
489
tag_updates, tag_conflicts = self.branch.tags.merge_to(
490
self.master_branch.tags)
492
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
493
note(gettext("Conflicting tags in bound branch:\n{0}".format(
494
"\n".join(warning_lines))))
496
def _select_reporter(self):
497
"""Select the CommitReporter to use."""
499
return NullCommitReporter()
500
return ReportCommitToLog()
502
def _check_pointless(self):
503
if self.allow_pointless:
505
# A merge with no effect on files
506
if len(self.parents) > 1:
508
if self.builder.any_changes():
510
raise PointlessCommit()
512
def _check_bound_branch(self, stack, possible_master_transports=None):
513
"""Check to see if the local branch is bound.
515
If it is bound, then most of the commit will actually be
516
done using the remote branch as the target branch.
517
Only at the end will the local branch be updated.
519
if self.local and not self.branch.get_bound_location():
520
raise errors.LocalRequiresBoundBranch()
523
self.master_branch = self.branch.get_master_branch(
524
possible_master_transports)
526
if not self.master_branch:
527
# make this branch the reference branch for out of date checks.
528
self.master_branch = self.branch
531
# If the master branch is bound, we must fail
532
master_bound_location = self.master_branch.get_bound_location()
533
if master_bound_location:
534
raise errors.CommitToDoubleBoundBranch(
535
self.branch, self.master_branch, master_bound_location)
537
# TODO: jam 20051230 We could automatically push local
538
# commits to the remote branch if they would fit.
539
# But for now, just require remote to be identical
542
# Make sure the local branch is identical to the master
543
master_revid = self.master_branch.last_revision()
544
local_revid = self.branch.last_revision()
545
if local_revid != master_revid:
546
raise errors.BoundBranchOutOfDate(self.branch,
549
# Now things are ready to change the master branch
551
self.bound_branch = self.branch
552
stack.enter_context(self.master_branch.lock_write())
554
def _check_out_of_date_tree(self):
555
"""Check that the working tree is up to date.
557
:return: old_revision_number, old_revision_id, new_revision_number
561
first_tree_parent = self.work_tree.get_parent_ids()[0]
563
# if there are no parents, treat our parent as 'None'
564
# this is so that we still consider the master branch
565
# - in a checkout scenario the tree may have no
566
# parents but the branch may do.
567
first_tree_parent = breezy.revision.NULL_REVISION
568
if (self.master_branch._format.stores_revno() or
569
self.config_stack.get('calculate_revnos')):
571
old_revno, master_last = self.master_branch.last_revision_info()
572
except errors.UnsupportedOperation:
573
master_last = self.master_branch.last_revision()
574
old_revno = self.branch.revision_id_to_revno(master_last)
576
master_last = self.master_branch.last_revision()
578
if master_last != first_tree_parent:
579
if master_last != breezy.revision.NULL_REVISION:
580
raise errors.OutOfDateTree(self.work_tree)
581
if (old_revno is not None and
582
self.branch.repository.has_revision(first_tree_parent)):
583
new_revno = old_revno + 1
585
# ghost parents never appear in revision history.
587
return old_revno, master_last, new_revno
589
def _process_pre_hooks(self, old_revno, new_revno):
590
"""Process any registered pre commit hooks."""
591
self._set_progress_stage("Running pre_commit hooks")
592
self._process_hooks("pre_commit", old_revno, new_revno)
594
def _process_post_hooks(self, old_revno, new_revno):
595
"""Process any registered post commit hooks."""
596
# Process the post commit hooks, if any
597
self._set_progress_stage("Running post_commit hooks")
598
# old style commit hooks - should be deprecated ? (obsoleted in
599
# 0.15^H^H^H^H 2.5.0)
600
post_commit = self.config_stack.get('post_commit')
601
if post_commit is not None:
602
hooks = post_commit.split(' ')
603
# this would be nicer with twisted.python.reflect.namedAny
605
result = eval(hook + '(branch, rev_id)',
606
{'branch': self.branch,
608
'rev_id': self.rev_id})
609
# process new style post commit hooks
610
self._process_hooks("post_commit", old_revno, new_revno)
612
def _process_hooks(self, hook_name, old_revno, new_revno):
613
if not Branch.hooks[hook_name]:
616
# new style commit hooks:
617
if not self.bound_branch:
618
hook_master = self.branch
621
hook_master = self.master_branch
622
hook_local = self.branch
623
# With bound branches, when the master is behind the local branch,
624
# the 'old_revno' and old_revid values here are incorrect.
625
# XXX: FIXME ^. RBC 20060206
627
old_revid = self.parents[0]
629
old_revid = breezy.revision.NULL_REVISION
631
if hook_name == "pre_commit":
632
future_tree = self.builder.revision_tree()
633
tree_delta = future_tree.changes_from(self.basis_tree,
636
for hook in Branch.hooks[hook_name]:
637
# show the running hook in the progress bar. As hooks may
638
# end up doing nothing (e.g. because they are not configured by
639
# the user) this is still showing progress, not showing overall
640
# actions - its up to each plugin to show a UI if it want's to
641
# (such as 'Emailing diff to foo@example.com').
642
self.pb_stage_name = "Running %s hooks [%s]" % \
643
(hook_name, Branch.hooks.get_hook_name(hook))
644
self._emit_progress()
645
if 'hooks' in debug.debug_flags:
646
mutter("Invoking commit hook: %r", hook)
647
if hook_name == "post_commit":
648
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
650
elif hook_name == "pre_commit":
651
hook(hook_local, hook_master,
652
old_revno, old_revid, new_revno, self.rev_id,
653
tree_delta, future_tree)
655
def _update_builder_with_changes(self):
656
"""Update the commit builder with the data about what has changed.
658
specific_files = self.specific_files
659
mutter("Selecting files for commit with filter %r", specific_files)
662
iter_changes = self.work_tree.iter_changes(
663
self.basis_tree, specific_files=specific_files)
665
iter_changes = filter_excluded(iter_changes, self.exclude)
666
iter_changes = self._filter_iter_changes(iter_changes)
667
for path, fs_hash in self.builder.record_iter_changes(
668
self.work_tree, self.basis_revid, iter_changes):
669
self.work_tree._observed_sha1(path, fs_hash)
671
def _filter_iter_changes(self, iter_changes):
672
"""Process iter_changes.
674
This method reports on the changes in iter_changes to the user, and
675
converts 'missing' entries in the iter_changes iterator to 'deleted'
676
entries. 'missing' entries have their
678
:param iter_changes: An iter_changes to process.
679
:return: A generator of changes.
681
reporter = self.reporter
682
report_changes = reporter.is_verbose()
684
for change in iter_changes:
686
old_path = change.path[0]
687
new_path = change.path[1]
688
versioned = change.versioned[1]
689
kind = change.kind[1]
690
versioned = change.versioned[1]
691
if kind is None and versioned:
694
reporter.missing(new_path)
695
if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
696
trace.warning('Ignoring "%s" as symlinks are not '
697
'supported on this filesystem.' % (change.path[0],))
699
deleted_paths.append(change.path[1])
700
# Reset the new path (None) and new versioned flag (False)
701
change = change.discard_new()
702
new_path = change.path[1]
704
elif kind == 'tree-reference':
705
if self.recursive == 'down':
706
self._commit_nested_tree(change.path[1])
707
if change.versioned[0] or change.versioned[1]:
711
reporter.deleted(old_path)
712
elif old_path is None:
713
reporter.snapshot_change(gettext('added'), new_path)
714
elif old_path != new_path:
715
reporter.renamed(gettext('renamed'),
719
or self.work_tree.branch.repository._format.rich_root_data):
720
# Don't report on changes to '' in non rich root
722
reporter.snapshot_change(
723
gettext('modified'), new_path)
724
self._next_progress_entry()
725
# Unversion files that were found to be deleted
726
self.deleted_paths = deleted_paths
728
def _check_strict(self):
729
# XXX: when we use iter_changes this would likely be faster if
730
# iter_changes would check for us (even in the presence of
733
# raise an exception as soon as we find a single unknown.
734
for unknown in self.work_tree.unknowns():
735
raise StrictCommitFailed()
737
def _commit_nested_tree(self, path):
738
"Commit a nested tree."
739
sub_tree = self.work_tree.get_nested_tree(path)
740
# FIXME: be more comprehensive here:
741
# this works when both trees are in --trees repository,
742
# but when both are bound to a different repository,
743
# it fails; a better way of approaching this is to
744
# finally implement the explicit-caches approach design
745
# a while back - RBC 20070306.
746
if sub_tree.branch.repository.has_same_location(
747
self.work_tree.branch.repository):
748
sub_tree.branch.repository = \
749
self.work_tree.branch.repository
751
return sub_tree.commit(message=None, revprops=self.revprops,
752
recursive=self.recursive,
753
message_callback=self.message_callback,
754
timestamp=self.timestamp,
755
timezone=self.timezone,
756
committer=self.committer,
757
allow_pointless=self.allow_pointless,
758
strict=self.strict, verbose=self.verbose,
759
local=self.local, reporter=self.reporter)
760
except PointlessCommit:
761
return self.work_tree.get_reference_revision(path)
763
def _set_progress_stage(self, name, counter=False):
764
"""Set the progress stage and emit an update to the progress bar."""
765
self.pb_stage_name = name
766
self.pb_stage_count += 1
768
self.pb_entries_count = 0
770
self.pb_entries_count = None
771
self._emit_progress()
773
def _next_progress_entry(self):
774
"""Emit an update to the progress bar and increment the entry count."""
775
self.pb_entries_count += 1
776
self._emit_progress()
778
def _emit_progress(self):
779
if self.pb_entries_count is not None:
780
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
781
self.pb_entries_count)
783
text = gettext("%s - Stage") % (self.pb_stage_name, )
784
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
breezy/commit.py
