1
# Copyright (C) 2005, 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# The newly committed revision is going to have a shape corresponding
19
# to that of the working inventory. Files that are not in the
20
# working tree and that were in the predecessor are reported as
21
# removed --- this can include files that were either removed from the
22
# inventory or deleted in the working tree. If they were only
23
# deleted from disk, they are removed from the working inventory.
25
# We then consider the remaining entries, which will be in the new
26
# version. Directory entries are simply copied across. File entries
27
# must be checked to see if a new version of the file should be
28
# recorded. For each parent revision inventory, we check to see what
29
# version of the file was present. If the file was present in at
30
# least one tree, and if it was the same version in all the trees,
31
# then we can just refer to that version. Otherwise, a new version
32
# representing the merger of the file versions must be added.
34
# TODO: Update hashcache before and after - or does the WorkingTree
37
# TODO: Rather than mashing together the ancestry and storing it back,
38
# perhaps the weave should have single method which does it all in one
39
# go, avoiding a lot of redundant work.
41
# TODO: Perhaps give a warning if one of the revisions marked as
42
# merged is already in the ancestry, and then don't record it as a
45
# TODO: If the file is newly merged but unchanged from the version it
46
# merges from, then it should still be reported as newly added
47
# relative to the basis revision.
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
# the rest of the code; add a deprecation of the old name.
57
from cStringIO import StringIO
64
from bzrlib.branch import Branch
66
from bzrlib.errors import (BzrError, PointlessCommit,
70
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
71
is_inside_or_parent_of_any,
72
quotefn, sha_file, split_lines)
73
from bzrlib.testament import Testament
74
from bzrlib.trace import mutter, note, warning
75
from bzrlib.xml5 import serializer_v5
76
from bzrlib.inventory import Inventory, InventoryEntry
77
from bzrlib import symbol_versioning
78
from bzrlib.symbol_versioning import (deprecated_passed,
81
from bzrlib.workingtree import WorkingTree
85
class NullCommitReporter(object):
86
"""I report on progress of a commit."""
88
def snapshot_change(self, change, path):
91
def completed(self, revno, rev_id):
94
def deleted(self, file_id):
97
def escaped(self, escape_count, message):
100
def missing(self, path):
103
def renamed(self, change, old_path, new_path):
107
class ReportCommitToLog(NullCommitReporter):
109
def _note(self, format, *args):
112
Subclasses may choose to override this method.
116
def snapshot_change(self, change, path):
117
if change == 'unchanged':
119
if change == 'added' and path == '':
121
self._note("%s %s", change, path)
123
def completed(self, revno, rev_id):
124
self._note('Committed revision %d.', revno)
126
def deleted(self, file_id):
127
self._note('deleted %s', file_id)
129
def escaped(self, escape_count, message):
130
self._note("replaced %d control characters in message", escape_count)
132
def missing(self, path):
133
self._note('missing %s', path)
135
def renamed(self, change, old_path, new_path):
136
self._note('%s %s => %s', change, old_path, new_path)
139
class Commit(object):
140
"""Task of committing a new revision.
142
This is a MethodObject: it accumulates state as the commit is
143
prepared, and then it is discarded. It doesn't represent
144
historical revisions, just the act of recording a new one.
147
Modified to hold a list of files that have been deleted from
148
the working directory; these should be removed from the
154
if reporter is not None:
155
self.reporter = reporter
157
self.reporter = NullCommitReporter()
167
allow_pointless=True,
175
message_callback=None,
177
"""Commit working copy as a new revision.
179
:param message: the commit message (it or message_callback is required)
181
:param timestamp: if not None, seconds-since-epoch for a
182
postdated/predated commit.
184
:param specific_files: If true, commit only those files.
186
:param rev_id: If set, use this as the new revision id.
187
Useful for test or import commands that need to tightly
188
control what revisions are assigned. If you duplicate
189
a revision id that exists elsewhere it is your own fault.
190
If null (default), a time/random revision id is generated.
192
:param allow_pointless: If true (default), commit even if nothing
193
has changed and no merges are recorded.
195
:param strict: If true, don't allow a commit if the working tree
196
contains unknown files.
198
:param revprops: Properties for new revision
199
:param local: Perform a local only commit.
200
:param recursive: If set to 'down', commit in any subtrees that have
201
pending changes of any sort during this commit.
203
mutter('preparing to commit')
205
if working_tree is None:
206
raise BzrError("working_tree must be passed into commit().")
208
self.work_tree = working_tree
209
self.branch = self.work_tree.branch
210
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
211
if not self.branch.repository.supports_rich_root():
212
raise errors.RootNotRich()
213
if message_callback is None:
214
if message is not None:
215
if isinstance(message, str):
216
message = message.decode(bzrlib.user_encoding)
217
message_callback = lambda x: message
219
raise BzrError("The message or message_callback keyword"
220
" parameter is required for commit().")
222
self.bound_branch = None
224
self.master_branch = None
225
self.master_locked = False
227
self.specific_files = specific_files
228
self.allow_pointless = allow_pointless
229
self.recursive = recursive
230
self.revprops = revprops
231
self.message_callback = message_callback
232
self.timestamp = timestamp
233
self.timezone = timezone
234
self.committer = committer
236
self.verbose = verbose
238
if reporter is None and self.reporter is None:
239
self.reporter = NullCommitReporter()
240
elif reporter is not None:
241
self.reporter = reporter
243
self.work_tree.lock_write()
244
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
245
self.basis_tree = self.work_tree.basis_tree()
246
self.basis_tree.lock_read()
248
# Cannot commit with conflicts present.
249
if len(self.work_tree.conflicts()) > 0:
250
raise ConflictsInTree
252
# Setup the bound branch variables as needed.
253
self._check_bound_branch()
255
# Check that the working tree is up to date
256
old_revno,new_revno = self._check_out_of_date_tree()
259
# raise an exception as soon as we find a single unknown.
260
for unknown in self.work_tree.unknowns():
261
raise StrictCommitFailed()
263
if self.config is None:
264
self.config = self.branch.get_config()
266
# If provided, ensure the specified files are versioned
267
if specific_files is not None:
268
# Note: We don't actually need the IDs here. This routine
269
# is being called because it raises PathNotVerisonedError
270
# as a side effect of finding the IDs.
271
# XXX: Dont we have filter_unversioned to do this more
273
tree.find_ids_across_trees(specific_files,
274
[self.basis_tree, self.work_tree])
276
# Setup the progress bar. As the number of files that need to be
277
# committed in unknown, progress is reported as stages.
278
# We keep track of entries separately though and include that
279
# information in the progress bar during the relevant stages.
280
self.pb_stage_name = ""
281
self.pb_stage_count = 0
282
self.pb_stage_total = 4
283
if self.bound_branch:
284
self.pb_stage_total += 1
285
self.pb.show_pct = False
286
self.pb.show_spinner = False
287
self.pb.show_eta = False
288
self.pb.show_count = True
289
self.pb.show_bar = False
291
# After a merge, a selected file commit is not supported.
292
# See 'bzr help merge' for an explanation as to why.
293
self.basis_inv = self.basis_tree.inventory
294
self._gather_parents()
295
if len(self.parents) > 1 and self.specific_files:
296
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
298
# Collect the changes
299
self._emit_progress_set_stage("Collecting changes", show_entries=True)
300
self.builder = self.branch.get_commit_builder(self.parents,
301
self.config, timestamp, timezone, committer, revprops, rev_id)
302
self._update_builder_with_changes()
303
self._check_pointless()
305
# TODO: Now the new inventory is known, check for conflicts.
306
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
307
# weave lines, because nothing should be recorded until it is known
308
# that commit will succeed.
309
self._emit_progress_set_stage("Saving data locally")
310
self.builder.finish_inventory()
312
# Prompt the user for a commit message if none provided
313
message = message_callback(self)
314
assert isinstance(message, unicode), type(message)
315
self.message = message
316
self._escape_commit_message()
318
# Add revision data to the local branch
319
self.rev_id = self.builder.commit(self.message)
321
# Upload revision data to the master.
322
# this will propagate merged revisions too if needed.
323
if self.bound_branch:
324
self._emit_progress_set_stage("Uploading data to master branch")
325
self.master_branch.repository.fetch(self.branch.repository,
326
revision_id=self.rev_id)
327
# now the master has the revision data
328
# 'commit' to the master first so a timeout here causes the
329
# local branch to be out of date
330
self.master_branch.set_last_revision_info(new_revno,
333
# and now do the commit locally.
334
self.branch.set_last_revision_info(new_revno, self.rev_id)
336
# Make the working tree up to date with the branch
337
self._emit_progress_set_stage("Updating the working tree")
338
rev_tree = self.builder.revision_tree()
339
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
340
self.reporter.completed(new_revno, self.rev_id)
341
self._process_hooks(old_revno, new_revno)
346
def _any_real_changes(self):
347
"""Are there real changes between new_inventory and basis?
349
For trees without rich roots, inv.root.revision changes every commit.
350
But if that is the only change, we want to treat it as though there
353
new_entries = self.builder.new_inventory.iter_entries()
354
basis_entries = self.basis_inv.iter_entries()
355
new_path, new_root_ie = new_entries.next()
356
basis_path, basis_root_ie = basis_entries.next()
358
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
359
def ie_equal_no_revision(this, other):
360
return ((this.file_id == other.file_id)
361
and (this.name == other.name)
362
and (this.symlink_target == other.symlink_target)
363
and (this.text_sha1 == other.text_sha1)
364
and (this.text_size == other.text_size)
365
and (this.text_id == other.text_id)
366
and (this.parent_id == other.parent_id)
367
and (this.kind == other.kind)
368
and (this.executable == other.executable)
369
and (this.reference_revision == other.reference_revision)
371
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
374
for new_ie, basis_ie in zip(new_entries, basis_entries):
375
if new_ie != basis_ie:
378
# No actual changes present
381
def _check_pointless(self):
382
if self.allow_pointless:
384
# A merge with no effect on files
385
if len(self.parents) > 1:
387
# work around the fact that a newly-initted tree does differ from its
389
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
390
raise PointlessCommit()
391
# Shortcut, if the number of entries changes, then we obviously have
393
if len(self.builder.new_inventory) != len(self.basis_inv):
395
# If length == 1, then we only have the root entry. Which means
396
# that there is no real difference (only the root could be different)
397
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
399
raise PointlessCommit()
401
def _check_bound_branch(self):
402
"""Check to see if the local branch is bound.
404
If it is bound, then most of the commit will actually be
405
done using the remote branch as the target branch.
406
Only at the end will the local branch be updated.
408
if self.local and not self.branch.get_bound_location():
409
raise errors.LocalRequiresBoundBranch()
412
self.master_branch = self.branch.get_master_branch()
414
if not self.master_branch:
415
# make this branch the reference branch for out of date checks.
416
self.master_branch = self.branch
419
# If the master branch is bound, we must fail
420
master_bound_location = self.master_branch.get_bound_location()
421
if master_bound_location:
422
raise errors.CommitToDoubleBoundBranch(self.branch,
423
self.master_branch, master_bound_location)
425
# TODO: jam 20051230 We could automatically push local
426
# commits to the remote branch if they would fit.
427
# But for now, just require remote to be identical
430
# Make sure the local branch is identical to the master
431
master_info = self.master_branch.last_revision_info()
432
local_info = self.branch.last_revision_info()
433
if local_info != master_info:
434
raise errors.BoundBranchOutOfDate(self.branch,
437
# Now things are ready to change the master branch
439
self.bound_branch = self.branch
440
self.master_branch.lock_write()
441
self.master_locked = True
443
def _check_out_of_date_tree(self):
444
"""Check that the working tree is up to date.
446
:return: old_revision_number,new_revision_number tuple
449
first_tree_parent = self.work_tree.get_parent_ids()[0]
451
# if there are no parents, treat our parent as 'None'
452
# this is so that we still consider the master branch
453
# - in a checkout scenario the tree may have no
454
# parents but the branch may do.
455
first_tree_parent = bzrlib.revision.NULL_REVISION
456
old_revno, master_last = self.master_branch.last_revision_info()
457
if master_last != first_tree_parent:
458
if master_last != bzrlib.revision.NULL_REVISION:
459
raise errors.OutOfDateTree(self.work_tree)
460
if self.branch.repository.has_revision(first_tree_parent):
461
new_revno = old_revno + 1
463
# ghost parents never appear in revision history.
465
return old_revno,new_revno
467
def _process_hooks(self, old_revno, new_revno):
468
"""Process any registered commit hooks."""
469
# Process the post commit hooks, if any
470
self._emit_progress_set_stage("Running post commit hooks")
471
# old style commit hooks - should be deprecated ? (obsoleted in
473
if self.config.post_commit() is not None:
474
hooks = self.config.post_commit().split(' ')
475
# this would be nicer with twisted.python.reflect.namedAny
477
result = eval(hook + '(branch, rev_id)',
478
{'branch':self.branch,
480
'rev_id':self.rev_id})
481
# new style commit hooks:
482
if not self.bound_branch:
483
hook_master = self.branch
486
hook_master = self.master_branch
487
hook_local = self.branch
488
# With bound branches, when the master is behind the local branch,
489
# the 'old_revno' and old_revid values here are incorrect.
490
# XXX: FIXME ^. RBC 20060206
492
old_revid = self.parents[0]
494
old_revid = bzrlib.revision.NULL_REVISION
495
for hook in Branch.hooks['post_commit']:
496
# show the running hook in the progress bar. As hooks may
497
# end up doing nothing (e.g. because they are not configured by
498
# the user) this is still showing progress, not showing overall
499
# actions - its up to each plugin to show a UI if it want's to
500
# (such as 'Emailing diff to foo@example.com').
501
self.pb_stage_name = "Running post commit hooks [%s]" % \
502
Branch.hooks.get_hook_name(hook)
503
self._emit_progress()
504
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
508
"""Cleanup any open locks, progress bars etc."""
509
cleanups = [self._cleanup_bound_branch,
510
self.basis_tree.unlock,
511
self.work_tree.unlock,
513
found_exception = None
514
for cleanup in cleanups:
517
# we want every cleanup to run no matter what.
518
# so we have a catchall here, but we will raise the
519
# last encountered exception up the stack: and
520
# typically this will be useful enough.
523
if found_exception is not None:
524
# don't do a plan raise, because the last exception may have been
525
# trashed, e is our sure-to-work exception even though it loses the
526
# full traceback. XXX: RBC 20060421 perhaps we could check the
527
# exc_info and if its the same one do a plain raise otherwise
528
# 'raise e' as we do now.
531
def _cleanup_bound_branch(self):
532
"""Executed at the end of a try/finally to cleanup a bound branch.
534
If the branch wasn't bound, this is a no-op.
535
If it was, it resents self.branch to the local branch, instead
538
if not self.bound_branch:
540
if self.master_locked:
541
self.master_branch.unlock()
543
def _escape_commit_message(self):
544
"""Replace xml-incompatible control characters."""
545
# FIXME: RBC 20060419 this should be done by the revision
546
# serialiser not by commit. Then we can also add an unescaper
547
# in the deserializer and start roundtripping revision messages
548
# precisely. See repository_implementations/test_repository.py
550
# Python strings can include characters that can't be
551
# represented in well-formed XML; escape characters that
552
# aren't listed in the XML specification
553
# (http://www.w3.org/TR/REC-xml/#NT-Char).
554
self.message, escape_count = re.subn(
555
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
556
lambda match: match.group(0).encode('unicode_escape'),
559
self.reporter.escaped(escape_count, self.message)
561
def _gather_parents(self):
562
"""Record the parents of a merge for merge detection."""
563
# TODO: Make sure that this list doesn't contain duplicate
564
# entries and the order is preserved when doing this.
565
self.parents = self.work_tree.get_parent_ids()
566
self.parent_invs = [self.basis_inv]
567
for revision in self.parents[1:]:
568
if self.branch.repository.has_revision(revision):
569
mutter('commit parent revision {%s}', revision)
570
inventory = self.branch.repository.get_inventory(revision)
571
self.parent_invs.append(inventory)
573
mutter('commit parent ghost revision {%s}', revision)
575
def _update_builder_with_changes(self):
576
"""Update the commit builder with the data about what has changed.
578
# Build the revision inventory.
580
# This starts by creating a new empty inventory. Depending on
581
# which files are selected for commit, and what is present in the
582
# current tree, the new inventory is populated. inventory entries
583
# which are candidates for modification have their revision set to
584
# None; inventory entries that are carried over untouched have their
585
# revision set to their prior value.
587
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
588
# results to create a new inventory at the same time, which results
589
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
592
specific_files = self.specific_files
593
mutter("Selecting files for commit with filter %s", specific_files)
594
work_inv = self.work_tree.inventory
595
assert work_inv.root is not None
596
self.pb_entries_total = len(work_inv)
598
# Check and warn about old CommitBuilders
599
entries = work_inv.iter_entries()
600
if not self.builder.record_root_entry:
601
symbol_versioning.warn('CommitBuilders should support recording'
602
' the root entry as of bzr 0.10.', DeprecationWarning,
604
self.builder.new_inventory.add(self.basis_inv.root.copy())
608
deleted_paths = set()
609
for path, new_ie in entries:
610
self._emit_progress_next_entry()
611
file_id = new_ie.file_id
613
# Skip files that have been deleted from the working tree.
614
# The deleted files/directories are also recorded so they
615
# can be explicitly unversioned later. Note that when a
616
# filter of specific files is given, we must only skip/record
617
# deleted files matching that filter.
618
if is_inside_any(deleted_paths, path):
620
if not specific_files or is_inside_any(specific_files, path):
621
if not self.work_tree.has_filename(path):
622
deleted_paths.add(path)
623
self.reporter.missing(path)
624
deleted_ids.append(file_id)
627
kind = self.work_tree.kind(file_id)
628
if kind == 'tree-reference' and self.recursive == 'down':
629
# nested tree: commit in it
630
sub_tree = WorkingTree.open(self.work_tree.abspath(path))
631
# FIXME: be more comprehensive here:
632
# this works when both trees are in --trees repository,
633
# but when both are bound to a different repository,
634
# it fails; a better way of approaching this is to
635
# finally implement the explicit-caches approach design
636
# a while back - RBC 20070306.
637
if (sub_tree.branch.repository.bzrdir.root_transport.base
639
self.work_tree.branch.repository.bzrdir.root_transport.base):
640
sub_tree.branch.repository = \
641
self.work_tree.branch.repository
643
sub_tree.commit(message=None, revprops=self.revprops,
644
recursive=self.recursive,
645
message_callback=self.message_callback,
646
timestamp=self.timestamp, timezone=self.timezone,
647
committer=self.committer,
648
allow_pointless=self.allow_pointless,
649
strict=self.strict, verbose=self.verbose,
650
local=self.local, reporter=self.reporter)
651
except errors.PointlessCommit:
653
if kind != new_ie.kind:
654
new_ie = inventory.make_entry(kind, new_ie.name,
655
new_ie.parent_id, file_id)
656
except errors.NoSuchFile:
658
# mutter('check %s {%s}', path, file_id)
659
if (not specific_files or
660
is_inside_or_parent_of_any(specific_files, path)):
661
# mutter('%s selected for commit', path)
665
# mutter('%s not selected for commit', path)
666
if self.basis_inv.has_id(file_id):
667
ie = self.basis_inv[file_id].copy()
669
# this entry is new and not being committed
671
self.builder.record_entry_contents(ie, self.parent_invs,
672
path, self.work_tree)
673
# describe the nature of the change that has occurred relative to
674
# the basis inventory.
675
if (self.basis_inv.has_id(ie.file_id)):
676
basis_ie = self.basis_inv[ie.file_id]
679
change = ie.describe_change(basis_ie, ie)
680
if change in (InventoryEntry.RENAMED,
681
InventoryEntry.MODIFIED_AND_RENAMED):
682
old_path = self.basis_inv.id2path(ie.file_id)
683
self.reporter.renamed(change, old_path, path)
685
self.reporter.snapshot_change(change, path)
687
# Unversion IDs that were found to be deleted
688
self.work_tree.unversion(deleted_ids)
690
# If specific files/directories were nominated, it is possible
691
# that some data from outside those needs to be preserved from
692
# the basis tree. For example, if a file x is moved from out of
693
# directory foo into directory bar and the user requests
694
# ``commit foo``, then information about bar/x must also be
697
for path, new_ie in self.basis_inv.iter_entries():
698
if new_ie.file_id in work_inv:
700
if is_inside_any(specific_files, path):
704
self.builder.record_entry_contents(ie, self.parent_invs, path,
707
# Report what was deleted. We could skip this when no deletes are
708
# detected to gain a performance win, but it arguably serves as a
709
# 'safety check' by informing the user whenever anything disappears.
710
for path, ie in self.basis_inv.iter_entries():
711
if ie.file_id not in self.builder.new_inventory:
712
self.reporter.deleted(path)
714
def _emit_progress_set_stage(self, name, show_entries=False):
715
"""Set the progress stage and emit an update to the progress bar."""
716
self.pb_stage_name = name
717
self.pb_stage_count += 1
718
self.pb_entries_show = show_entries
720
self.pb_entries_count = 0
721
self.pb_entries_total = '?'
722
self._emit_progress()
724
def _emit_progress_next_entry(self):
725
"""Emit an update to the progress bar and increment the file count."""
726
self.pb_entries_count += 1
727
self._emit_progress()
729
def _emit_progress(self):
730
if self.pb_entries_show:
731
text = "%s [Entry %d/%s] - Stage" % (self.pb_stage_name,
732
self.pb_entries_count,str(self.pb_entries_total))
734
text = "%s - Stage" % (self.pb_stage_name)
735
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
