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.
59
from .branch import Branch
60
from .cleanup import OperationWithCleanups
62
from .errors import (BzrError,
66
from .osutils import (get_user_encoding,
68
minimum_path_selection,
70
from .trace import mutter, note, is_quiet
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
old_path = change[1][0]
99
new_path = change[1][1]
101
new_excluded = (new_path is not None and
102
is_inside_any(exclude, new_path))
104
old_excluded = (old_path is not None and
105
is_inside_any(exclude, old_path))
107
if old_excluded and new_excluded:
110
if old_excluded or new_excluded:
111
# TODO(jelmer): Perhaps raise an error here instead?
117
class NullCommitReporter(object):
118
"""I report on progress of a commit."""
120
def started(self, revno, revid, location):
123
def snapshot_change(self, change, path):
126
def completed(self, revno, rev_id):
129
def deleted(self, path):
132
def missing(self, path):
135
def renamed(self, change, old_path, new_path):
138
def is_verbose(self):
142
class ReportCommitToLog(NullCommitReporter):
144
def _note(self, format, *args):
147
Subclasses may choose to override this method.
151
def snapshot_change(self, change, path):
152
if path == '' and change in (gettext('added'), gettext('modified')):
154
self._note("%s %s", change, path)
156
def started(self, revno, rev_id, location):
158
gettext('Committing to: %s'),
159
unescape_for_display(location, 'utf-8'))
161
def completed(self, revno, rev_id):
162
self._note(gettext('Committed revision %d.'), revno)
163
# self._note goes to the console too; so while we want to log the
164
# rev_id, we can't trivially only log it. (See bug 526425). Long
165
# term we should rearrange the reporting structure, but for now
166
# we just mutter seperately. We mutter the revid and revno together
167
# so that concurrent bzr invocations won't lead to confusion.
168
mutter('Committed revid %s as revno %d.', rev_id, revno)
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
operation = OperationWithCleanups(self._commit)
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
return operation.run(
295
specific_files=specific_files,
297
allow_pointless=allow_pointless,
300
working_tree=working_tree,
303
message_callback=message_callback,
306
possible_master_transports=possible_master_transports,
309
def _commit(self, operation, message, timestamp, timezone, committer,
310
specific_files, rev_id, allow_pointless, strict, verbose,
311
working_tree, local, reporter, message_callback, recursive,
312
exclude, possible_master_transports, lossy):
313
mutter('preparing to commit')
315
if working_tree is None:
316
raise BzrError("working_tree must be passed into commit().")
318
self.work_tree = working_tree
319
self.branch = self.work_tree.branch
320
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
321
if not self.branch.repository.supports_rich_root():
322
raise errors.RootNotRich()
323
if message_callback is None:
324
if message is not None:
325
if isinstance(message, bytes):
326
message = message.decode(get_user_encoding())
328
def message_callback(x):
331
raise BzrError("The message or message_callback keyword"
332
" parameter is required for commit().")
334
self.bound_branch = None
335
self.any_entries_deleted = False
336
if exclude is not None:
337
self.exclude = sorted(
338
minimum_path_selection(exclude))
342
self.master_branch = None
343
self.recursive = recursive
345
# self.specific_files is None to indicate no filter, or any iterable to
346
# indicate a filter - [] means no files at all, as per iter_changes.
347
if specific_files is not None:
348
self.specific_files = sorted(
349
minimum_path_selection(specific_files))
351
self.specific_files = None
353
self.allow_pointless = allow_pointless
354
self.message_callback = message_callback
355
self.timestamp = timestamp
356
self.timezone = timezone
357
self.committer = committer
359
self.verbose = verbose
361
self.work_tree.lock_write()
362
operation.add_cleanup(self.work_tree.unlock)
363
self.parents = self.work_tree.get_parent_ids()
364
self.pb = ui.ui_factory.nested_progress_bar()
365
operation.add_cleanup(self.pb.finished)
366
self.basis_revid = self.work_tree.last_revision()
367
self.basis_tree = self.work_tree.basis_tree()
368
self.basis_tree.lock_read()
369
operation.add_cleanup(self.basis_tree.unlock)
370
# Cannot commit with conflicts present.
371
if len(self.work_tree.conflicts()) > 0:
372
raise ConflictsInTree
374
# Setup the bound branch variables as needed.
375
self._check_bound_branch(operation, possible_master_transports)
377
# Check that the working tree is up to date
378
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
380
# Complete configuration setup
381
if reporter is not None:
382
self.reporter = reporter
383
elif self.reporter is None:
384
self.reporter = self._select_reporter()
385
if self.config_stack is None:
386
self.config_stack = self.work_tree.get_config_stack()
388
# Setup the progress bar. As the number of files that need to be
389
# committed in unknown, progress is reported as stages.
390
# We keep track of entries separately though and include that
391
# information in the progress bar during the relevant stages.
392
self.pb_stage_name = ""
393
self.pb_stage_count = 0
394
self.pb_stage_total = 5
395
if self.bound_branch:
396
# 2 extra stages: "Uploading data to master branch" and "Merging
397
# tags to master branch"
398
self.pb_stage_total += 2
399
self.pb.show_pct = False
400
self.pb.show_spinner = False
401
self.pb.show_eta = False
402
self.pb.show_count = True
403
self.pb.show_bar = True
405
# After a merge, a selected file commit is not supported.
406
# See 'bzr help merge' for an explanation as to why.
407
if len(self.parents) > 1 and self.specific_files is not None:
408
raise CannotCommitSelectedFileMerge(self.specific_files)
409
# Excludes are a form of selected file commit.
410
if len(self.parents) > 1 and self.exclude:
411
raise CannotCommitSelectedFileMerge(self.exclude)
413
# Collect the changes
414
self._set_progress_stage("Collecting changes", counter=True)
416
self.builder = self.branch.get_commit_builder(
417
self.parents, self.config_stack, timestamp, timezone, committer,
418
self.revprops, rev_id, lossy=lossy)
420
if self.builder.updates_branch and self.bound_branch:
422
raise AssertionError(
423
"bound branches not supported for commit builders "
424
"that update the branch")
427
# find the location being committed to
428
if self.bound_branch:
429
master_location = self.master_branch.base
431
master_location = self.branch.base
433
# report the start of the commit
434
self.reporter.started(new_revno, self.rev_id, master_location)
436
self._update_builder_with_changes()
437
self._check_pointless()
439
# TODO: Now the new inventory is known, check for conflicts.
440
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
441
# weave lines, because nothing should be recorded until it is known
442
# that commit will succeed.
443
self._set_progress_stage("Saving data locally")
444
self.builder.finish_inventory()
446
# Prompt the user for a commit message if none provided
447
message = message_callback(self)
448
self.message = message
450
# Add revision data to the local branch
451
self.rev_id = self.builder.commit(self.message)
454
mutter("aborting commit write group because of exception:")
455
trace.log_exception_quietly()
459
self._update_branches(old_revno, old_revid, new_revno)
461
# Make the working tree be up to date with the branch. This
462
# includes automatic changes scheduled to be made to the tree, such
463
# as updating its basis and unversioning paths that were missing.
464
self.work_tree.unversion(self.deleted_paths)
465
self._set_progress_stage("Updating the working tree")
466
self.work_tree.update_basis_by_delta(self.rev_id,
467
self.builder.get_basis_delta())
468
self.reporter.completed(new_revno, self.rev_id)
469
self._process_post_hooks(old_revno, new_revno)
472
def _update_branches(self, old_revno, old_revid, new_revno):
473
"""Update the master and local branch to the new revision.
475
This will try to make sure that the master branch is updated
476
before the local branch.
478
:param old_revno: Revision number of master branch before the
480
:param old_revid: Tip of master branch before the commit
481
:param new_revno: Revision number of the new commit
483
if not self.builder.updates_branch:
484
self._process_pre_hooks(old_revno, new_revno)
486
# Upload revision data to the master.
487
# this will propagate merged revisions too if needed.
488
if self.bound_branch:
489
self._set_progress_stage("Uploading data to master branch")
490
# 'commit' to the master first so a timeout here causes the
491
# local branch to be out of date
492
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
493
self.branch, new_revno, self.rev_id, lossy=self._lossy)
495
self.branch.fetch(self.master_branch, self.rev_id)
497
# and now do the commit locally.
498
self.branch.set_last_revision_info(new_revno, self.rev_id)
501
self._process_pre_hooks(old_revno, new_revno)
502
except BaseException:
503
# The commit builder will already have updated the branch,
505
self.branch.set_last_revision_info(old_revno, old_revid)
508
# Merge local tags to remote
509
if self.bound_branch:
510
self._set_progress_stage("Merging tags to master branch")
511
tag_updates, tag_conflicts = self.branch.tags.merge_to(
512
self.master_branch.tags)
514
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
515
note(gettext("Conflicting tags in bound branch:\n{0}".format(
516
"\n".join(warning_lines))))
518
def _select_reporter(self):
519
"""Select the CommitReporter to use."""
521
return NullCommitReporter()
522
return ReportCommitToLog()
524
def _check_pointless(self):
525
if self.allow_pointless:
527
# A merge with no effect on files
528
if len(self.parents) > 1:
530
if self.builder.any_changes():
532
raise PointlessCommit()
534
def _check_bound_branch(self, operation, possible_master_transports=None):
535
"""Check to see if the local branch is bound.
537
If it is bound, then most of the commit will actually be
538
done using the remote branch as the target branch.
539
Only at the end will the local branch be updated.
541
if self.local and not self.branch.get_bound_location():
542
raise errors.LocalRequiresBoundBranch()
545
self.master_branch = self.branch.get_master_branch(
546
possible_master_transports)
548
if not self.master_branch:
549
# make this branch the reference branch for out of date checks.
550
self.master_branch = self.branch
553
# If the master branch is bound, we must fail
554
master_bound_location = self.master_branch.get_bound_location()
555
if master_bound_location:
556
raise errors.CommitToDoubleBoundBranch(
557
self.branch, self.master_branch, master_bound_location)
559
# TODO: jam 20051230 We could automatically push local
560
# commits to the remote branch if they would fit.
561
# But for now, just require remote to be identical
564
# Make sure the local branch is identical to the master
565
master_revid = self.master_branch.last_revision()
566
local_revid = self.branch.last_revision()
567
if local_revid != master_revid:
568
raise errors.BoundBranchOutOfDate(self.branch,
571
# Now things are ready to change the master branch
573
self.bound_branch = self.branch
574
self.master_branch.lock_write()
575
operation.add_cleanup(self.master_branch.unlock)
577
def _check_out_of_date_tree(self):
578
"""Check that the working tree is up to date.
580
:return: old_revision_number, old_revision_id, new_revision_number
584
first_tree_parent = self.work_tree.get_parent_ids()[0]
586
# if there are no parents, treat our parent as 'None'
587
# this is so that we still consider the master branch
588
# - in a checkout scenario the tree may have no
589
# parents but the branch may do.
590
first_tree_parent = breezy.revision.NULL_REVISION
592
old_revno, master_last = self.master_branch.last_revision_info()
593
except errors.UnsupportedOperation:
594
master_last = self.master_branch.last_revision()
595
old_revno = self.branch.revision_id_to_revno(master_last)
596
if master_last != first_tree_parent:
597
if master_last != breezy.revision.NULL_REVISION:
598
raise errors.OutOfDateTree(self.work_tree)
599
if self.branch.repository.has_revision(first_tree_parent):
600
new_revno = old_revno + 1
602
# ghost parents never appear in revision history.
604
return old_revno, master_last, new_revno
606
def _process_pre_hooks(self, old_revno, new_revno):
607
"""Process any registered pre commit hooks."""
608
self._set_progress_stage("Running pre_commit hooks")
609
self._process_hooks("pre_commit", old_revno, new_revno)
611
def _process_post_hooks(self, old_revno, new_revno):
612
"""Process any registered post commit hooks."""
613
# Process the post commit hooks, if any
614
self._set_progress_stage("Running post_commit hooks")
615
# old style commit hooks - should be deprecated ? (obsoleted in
616
# 0.15^H^H^H^H 2.5.0)
617
post_commit = self.config_stack.get('post_commit')
618
if post_commit is not None:
619
hooks = post_commit.split(' ')
620
# this would be nicer with twisted.python.reflect.namedAny
622
result = eval(hook + '(branch, rev_id)',
623
{'branch': self.branch,
625
'rev_id': self.rev_id})
626
# process new style post commit hooks
627
self._process_hooks("post_commit", old_revno, new_revno)
629
def _process_hooks(self, hook_name, old_revno, new_revno):
630
if not Branch.hooks[hook_name]:
633
# new style commit hooks:
634
if not self.bound_branch:
635
hook_master = self.branch
638
hook_master = self.master_branch
639
hook_local = self.branch
640
# With bound branches, when the master is behind the local branch,
641
# the 'old_revno' and old_revid values here are incorrect.
642
# XXX: FIXME ^. RBC 20060206
644
old_revid = self.parents[0]
646
old_revid = breezy.revision.NULL_REVISION
648
if hook_name == "pre_commit":
649
future_tree = self.builder.revision_tree()
650
tree_delta = future_tree.changes_from(self.basis_tree,
653
for hook in Branch.hooks[hook_name]:
654
# show the running hook in the progress bar. As hooks may
655
# end up doing nothing (e.g. because they are not configured by
656
# the user) this is still showing progress, not showing overall
657
# actions - its up to each plugin to show a UI if it want's to
658
# (such as 'Emailing diff to foo@example.com').
659
self.pb_stage_name = "Running %s hooks [%s]" % \
660
(hook_name, Branch.hooks.get_hook_name(hook))
661
self._emit_progress()
662
if 'hooks' in debug.debug_flags:
663
mutter("Invoking commit hook: %r", hook)
664
if hook_name == "post_commit":
665
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
667
elif hook_name == "pre_commit":
668
hook(hook_local, hook_master,
669
old_revno, old_revid, new_revno, self.rev_id,
670
tree_delta, future_tree)
672
def _update_builder_with_changes(self):
673
"""Update the commit builder with the data about what has changed.
675
specific_files = self.specific_files
676
mutter("Selecting files for commit with filter %r", specific_files)
679
iter_changes = self.work_tree.iter_changes(
680
self.basis_tree, specific_files=specific_files)
682
iter_changes = filter_excluded(iter_changes, self.exclude)
683
iter_changes = self._filter_iter_changes(iter_changes)
684
for path, fs_hash in self.builder.record_iter_changes(
685
self.work_tree, self.basis_revid, iter_changes):
686
self.work_tree._observed_sha1(path, fs_hash)
688
def _filter_iter_changes(self, iter_changes):
689
"""Process iter_changes.
691
This method reports on the changes in iter_changes to the user, and
692
converts 'missing' entries in the iter_changes iterator to 'deleted'
693
entries. 'missing' entries have their
695
:param iter_changes: An iter_changes to process.
696
:return: A generator of changes.
698
reporter = self.reporter
699
report_changes = reporter.is_verbose()
701
for change in iter_changes:
703
old_path = change[1][0]
704
new_path = change[1][1]
705
versioned = change[3][1]
707
versioned = change[3][1]
708
if kind is None and versioned:
711
reporter.missing(new_path)
712
deleted_paths.append(change[1][1])
713
# Reset the new path (None) and new versioned flag (False)
714
change = (change[0], (change[1][0], None), change[2],
715
(change[3][0], False)) + change[4:]
716
new_path = change[1][1]
718
elif kind == 'tree-reference':
719
if self.recursive == 'down':
720
self._commit_nested_tree(change[1][1])
721
if change[3][0] or change[3][1]:
725
reporter.deleted(old_path)
726
elif old_path is None:
727
reporter.snapshot_change(gettext('added'), new_path)
728
elif old_path != new_path:
729
reporter.renamed(gettext('renamed'),
733
or self.work_tree.branch.repository._format.rich_root_data):
734
# Don't report on changes to '' in non rich root
736
reporter.snapshot_change(
737
gettext('modified'), new_path)
738
self._next_progress_entry()
739
# Unversion files that were found to be deleted
740
self.deleted_paths = deleted_paths
742
def _check_strict(self):
743
# XXX: when we use iter_changes this would likely be faster if
744
# iter_changes would check for us (even in the presence of
747
# raise an exception as soon as we find a single unknown.
748
for unknown in self.work_tree.unknowns():
749
raise StrictCommitFailed()
751
def _commit_nested_tree(self, path):
752
"Commit a nested tree."
753
sub_tree = self.work_tree.get_nested_tree(path)
754
# FIXME: be more comprehensive here:
755
# this works when both trees are in --trees repository,
756
# but when both are bound to a different repository,
757
# it fails; a better way of approaching this is to
758
# finally implement the explicit-caches approach design
759
# a while back - RBC 20070306.
760
if sub_tree.branch.repository.has_same_location(
761
self.work_tree.branch.repository):
762
sub_tree.branch.repository = \
763
self.work_tree.branch.repository
765
return sub_tree.commit(message=None, revprops=self.revprops,
766
recursive=self.recursive,
767
message_callback=self.message_callback,
768
timestamp=self.timestamp,
769
timezone=self.timezone,
770
committer=self.committer,
771
allow_pointless=self.allow_pointless,
772
strict=self.strict, verbose=self.verbose,
773
local=self.local, reporter=self.reporter)
774
except PointlessCommit:
775
return self.work_tree.get_reference_revision(path)
777
def _set_progress_stage(self, name, counter=False):
778
"""Set the progress stage and emit an update to the progress bar."""
779
self.pb_stage_name = name
780
self.pb_stage_count += 1
782
self.pb_entries_count = 0
784
self.pb_entries_count = None
785
self._emit_progress()
787
def _next_progress_entry(self):
788
"""Emit an update to the progress bar and increment the entry count."""
789
self.pb_entries_count += 1
790
self._emit_progress()
792
def _emit_progress(self):
793
if self.pb_entries_count is not None:
794
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
795
self.pb_entries_count)
797
text = gettext("%s - Stage") % (self.pb_stage_name, )
798
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
breezy/commit.py
