1
# Copyright (C) 2005, 2006 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
# XXX: Can we do any better about making interrupted commits change
21
# TODO: Separate 'prepare' phase where we find a list of potentially
22
# committed files. We then can then pause the commit to prompt for a
23
# commit message, knowing the summary will be the same as what's
24
# actually used for the commit. (But perhaps simpler to simply get
25
# the tree status, then use that for a selective commit?)
27
# The newly committed revision is going to have a shape corresponding
28
# to that of the working inventory. Files that are not in the
29
# working tree and that were in the predecessor are reported as
30
# removed --- this can include files that were either removed from the
31
# inventory or deleted in the working tree. If they were only
32
# deleted from disk, they are removed from the working inventory.
34
# We then consider the remaining entries, which will be in the new
35
# version. Directory entries are simply copied across. File entries
36
# must be checked to see if a new version of the file should be
37
# recorded. For each parent revision inventory, we check to see what
38
# version of the file was present. If the file was present in at
39
# least one tree, and if it was the same version in all the trees,
40
# then we can just refer to that version. Otherwise, a new version
41
# representing the merger of the file versions must be added.
43
# TODO: Update hashcache before and after - or does the WorkingTree
46
# TODO: Rather than mashing together the ancestry and storing it back,
47
# perhaps the weave should have single method which does it all in one
48
# go, avoiding a lot of redundant work.
50
# TODO: Perhaps give a warning if one of the revisions marked as
51
# merged is already in the ancestry, and then don't record it as a
54
# TODO: If the file is newly merged but unchanged from the version it
55
# merges from, then it should still be reported as newly added
56
# relative to the basis revision.
58
# TODO: Do checks that the tree can be committed *before* running the
59
# editor; this should include checks for a pointless commit and for
60
# unknown or missing files.
62
# TODO: If commit fails, leave the message in a file somewhere.
64
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
65
# the rest of the code; add a deprecation of the old name.
72
from cStringIO import StringIO
79
from bzrlib.errors import (BzrError, PointlessCommit,
83
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
84
is_inside_or_parent_of_any,
85
quotefn, sha_file, split_lines)
86
from bzrlib.testament import Testament
87
from bzrlib.trace import mutter, note, warning
88
from bzrlib.xml5 import serializer_v5
89
from bzrlib.inventory import Inventory, InventoryEntry
90
from bzrlib import symbol_versioning
91
from bzrlib.symbol_versioning import (deprecated_passed,
94
from bzrlib.workingtree import WorkingTree
98
class NullCommitReporter(object):
99
"""I report on progress of a commit."""
101
def snapshot_change(self, change, path):
104
def completed(self, revno, rev_id):
107
def deleted(self, file_id):
110
def escaped(self, escape_count, message):
113
def missing(self, path):
116
def renamed(self, change, old_path, new_path):
120
class ReportCommitToLog(NullCommitReporter):
122
# this may be more useful if 'note' was replaced by an overridable
123
# method on self, which would allow more trivial subclassing.
124
# alternative, a callable could be passed in, allowing really trivial
125
# reuse for some uis. RBC 20060511
127
def snapshot_change(self, change, path):
128
if change == 'unchanged':
130
if change == 'added' and path == '':
132
note("%s %s", change, path)
134
def completed(self, revno, rev_id):
135
note('Committed revision %d.', revno)
137
def deleted(self, file_id):
138
note('deleted %s', file_id)
140
def escaped(self, escape_count, message):
141
note("replaced %d control characters in message", escape_count)
143
def missing(self, path):
144
note('missing %s', path)
146
def renamed(self, change, old_path, new_path):
147
note('%s %s => %s', change, old_path, new_path)
150
class Commit(object):
151
"""Task of committing a new revision.
153
This is a MethodObject: it accumulates state as the commit is
154
prepared, and then it is discarded. It doesn't represent
155
historical revisions, just the act of recording a new one.
158
Modified to hold a list of files that have been deleted from
159
the working directory; these should be removed from the
165
if reporter is not None:
166
self.reporter = reporter
168
self.reporter = NullCommitReporter()
169
if config is not None:
175
branch=DEPRECATED_PARAMETER, message=None,
181
allow_pointless=True,
189
"""Commit working copy as a new revision.
191
branch -- the deprecated branch to commit to. New callers should pass in
194
message -- the commit message, a mandatory parameter
196
timestamp -- if not None, seconds-since-epoch for a
197
postdated/predated commit.
199
specific_files -- If true, commit only those files.
201
rev_id -- If set, use this as the new revision id.
202
Useful for test or import commands that need to tightly
203
control what revisions are assigned. If you duplicate
204
a revision id that exists elsewhere it is your own fault.
205
If null (default), a time/random revision id is generated.
207
allow_pointless -- If true (default), commit even if nothing
208
has changed and no merges are recorded.
210
strict -- If true, don't allow a commit if the working tree
211
contains unknown files.
213
revprops -- Properties for new revision
214
:param local: Perform a local only commit.
216
mutter('preparing to commit')
218
if deprecated_passed(branch):
219
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
220
"deprecated as of bzr 0.8. Please use working_tree= instead.",
221
DeprecationWarning, stacklevel=2)
223
self.work_tree = self.branch.bzrdir.open_workingtree()
224
elif working_tree is None:
225
raise BzrError("One of branch and working_tree must be passed into commit().")
227
self.work_tree = working_tree
228
self.branch = self.work_tree.branch
230
raise BzrError("The message keyword parameter is required for commit().")
232
self.bound_branch = None
234
self.master_branch = None
235
self.master_locked = False
237
self.specific_files = specific_files
238
self.allow_pointless = allow_pointless
240
if reporter is None and self.reporter is None:
241
self.reporter = NullCommitReporter()
242
elif reporter is not None:
243
self.reporter = reporter
245
self.work_tree.lock_write()
246
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
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 for out of date working trees
257
first_tree_parent = self.work_tree.get_parent_ids()[0]
259
# if there are no parents, treat our parent as 'None'
260
# this is so that we still consier the master branch
261
# - in a checkout scenario the tree may have no
262
# parents but the branch may do.
263
first_tree_parent = None
264
master_last = self.master_branch.last_revision()
265
if (master_last is not None and
266
master_last != first_tree_parent):
267
raise errors.OutOfDateTree(self.work_tree)
270
# raise an exception as soon as we find a single unknown.
271
for unknown in self.work_tree.unknowns():
272
raise StrictCommitFailed()
274
if self.config is None:
275
self.config = self.branch.get_config()
277
if isinstance(message, str):
278
message = message.decode(bzrlib.user_encoding)
279
assert isinstance(message, unicode), type(message)
280
self.message = message
281
self._escape_commit_message()
283
self.work_inv = self.work_tree.inventory
284
self.basis_tree = self.work_tree.basis_tree()
285
self.basis_inv = self.basis_tree.inventory
286
if specific_files is not None:
287
# Ensure specified files are versioned
288
# (We don't actually need the ids here)
289
tree.find_ids_across_trees(specific_files,
290
[self.basis_tree, self.work_tree])
291
# one to finish, one for rev and inventory, and one for each
292
# inventory entry, and the same for the new inventory.
293
# note that this estimate is too long when we do a partial tree
294
# commit which excludes some new files from being considered.
295
# The estimate is corrected when we populate the new inv.
296
self.pb_total = len(self.work_inv) + 5
299
self._gather_parents()
300
if len(self.parents) > 1 and self.specific_files:
301
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
304
self.builder = self.branch.get_commit_builder(self.parents,
305
self.config, timestamp, timezone, committer, revprops, rev_id)
307
self._remove_deleted()
308
self._populate_new_inv()
309
self._report_deletes()
311
self._check_pointless()
313
self._emit_progress_update()
314
# TODO: Now the new inventory is known, check for conflicts and
315
# prompt the user for a commit message.
316
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
317
# weave lines, because nothing should be recorded until it is known
318
# that commit will succeed.
319
self.builder.finish_inventory()
320
self._emit_progress_update()
321
self.rev_id = self.builder.commit(self.message)
322
self._emit_progress_update()
323
# revision data is in the local branch now.
325
# upload revision data to the master.
326
# this will propagate merged revisions too if needed.
327
if self.bound_branch:
328
self.master_branch.repository.fetch(self.branch.repository,
329
revision_id=self.rev_id)
330
# now the master has the revision data
331
# 'commit' to the master first so a timeout here causes the local
332
# branch to be out of date
333
self.master_branch.append_revision(self.rev_id)
335
# and now do the commit locally.
336
self.branch.append_revision(self.rev_id)
338
rev_tree = self.builder.revision_tree()
339
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
340
# now the work tree is up to date with the branch
342
self.reporter.completed(self.branch.revno(), self.rev_id)
343
if self.config.post_commit() is not None:
344
hooks = self.config.post_commit().split(' ')
345
# this would be nicer with twisted.python.reflect.namedAny
347
result = eval(hook + '(branch, rev_id)',
348
{'branch':self.branch,
350
'rev_id':self.rev_id})
351
self._emit_progress_update()
356
def _any_real_changes(self):
357
"""Are there real changes between new_inventory and basis?
359
For trees without rich roots, inv.root.revision changes every commit.
360
But if that is the only change, we want to treat it as though there
363
new_entries = self.builder.new_inventory.iter_entries()
364
basis_entries = self.basis_inv.iter_entries()
365
new_path, new_root_ie = new_entries.next()
366
basis_path, basis_root_ie = basis_entries.next()
368
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
369
def ie_equal_no_revision(this, other):
370
return ((this.file_id == other.file_id)
371
and (this.name == other.name)
372
and (this.symlink_target == other.symlink_target)
373
and (this.text_sha1 == other.text_sha1)
374
and (this.text_size == other.text_size)
375
and (this.text_id == other.text_id)
376
and (this.parent_id == other.parent_id)
377
and (this.kind == other.kind)
378
and (this.executable == other.executable)
380
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
383
for new_ie, basis_ie in zip(new_entries, basis_entries):
384
if new_ie != basis_ie:
387
# No actual changes present
390
def _check_pointless(self):
391
if self.allow_pointless:
393
# A merge with no effect on files
394
if len(self.parents) > 1:
396
# work around the fact that a newly-initted tree does differ from its
398
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
399
raise PointlessCommit()
400
# Shortcut, if the number of entries changes, then we obviously have
402
if len(self.builder.new_inventory) != len(self.basis_inv):
404
# If length == 1, then we only have the root entry. Which means
405
# that there is no real difference (only the root could be different)
406
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
408
raise PointlessCommit()
410
def _check_bound_branch(self):
411
"""Check to see if the local branch is bound.
413
If it is bound, then most of the commit will actually be
414
done using the remote branch as the target branch.
415
Only at the end will the local branch be updated.
417
if self.local and not self.branch.get_bound_location():
418
raise errors.LocalRequiresBoundBranch()
421
self.master_branch = self.branch.get_master_branch()
423
if not self.master_branch:
424
# make this branch the reference branch for out of date checks.
425
self.master_branch = self.branch
428
# If the master branch is bound, we must fail
429
master_bound_location = self.master_branch.get_bound_location()
430
if master_bound_location:
431
raise errors.CommitToDoubleBoundBranch(self.branch,
432
self.master_branch, master_bound_location)
434
# TODO: jam 20051230 We could automatically push local
435
# commits to the remote branch if they would fit.
436
# But for now, just require remote to be identical
439
# Make sure the local branch is identical to the master
440
master_rh = self.master_branch.revision_history()
441
local_rh = self.branch.revision_history()
442
if local_rh != master_rh:
443
raise errors.BoundBranchOutOfDate(self.branch,
446
# Now things are ready to change the master branch
448
self.bound_branch = self.branch
449
self.master_branch.lock_write()
450
self.master_locked = True
453
"""Cleanup any open locks, progress bars etc."""
454
cleanups = [self._cleanup_bound_branch,
455
self.work_tree.unlock,
457
found_exception = None
458
for cleanup in cleanups:
461
# we want every cleanup to run no matter what.
462
# so we have a catchall here, but we will raise the
463
# last encountered exception up the stack: and
464
# typically this will be useful enough.
467
if found_exception is not None:
468
# don't do a plan raise, because the last exception may have been
469
# trashed, e is our sure-to-work exception even though it loses the
470
# full traceback. XXX: RBC 20060421 perhaps we could check the
471
# exc_info and if its the same one do a plain raise otherwise
472
# 'raise e' as we do now.
475
def _cleanup_bound_branch(self):
476
"""Executed at the end of a try/finally to cleanup a bound branch.
478
If the branch wasn't bound, this is a no-op.
479
If it was, it resents self.branch to the local branch, instead
482
if not self.bound_branch:
484
if self.master_locked:
485
self.master_branch.unlock()
487
def _escape_commit_message(self):
488
"""Replace xml-incompatible control characters."""
489
# FIXME: RBC 20060419 this should be done by the revision
490
# serialiser not by commit. Then we can also add an unescaper
491
# in the deserializer and start roundtripping revision messages
492
# precisely. See repository_implementations/test_repository.py
494
# Python strings can include characters that can't be
495
# represented in well-formed XML; escape characters that
496
# aren't listed in the XML specification
497
# (http://www.w3.org/TR/REC-xml/#NT-Char).
498
self.message, escape_count = re.subn(
499
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
500
lambda match: match.group(0).encode('unicode_escape'),
503
self.reporter.escaped(escape_count, self.message)
505
def _gather_parents(self):
506
"""Record the parents of a merge for merge detection."""
507
# TODO: Make sure that this list doesn't contain duplicate
508
# entries and the order is preserved when doing this.
509
self.parents = self.work_tree.get_parent_ids()
510
self.parent_invs = []
511
for revision in self.parents:
512
if self.branch.repository.has_revision(revision):
513
mutter('commit parent revision {%s}', revision)
514
inventory = self.branch.repository.get_inventory(revision)
515
self.parent_invs.append(inventory)
517
mutter('commit parent ghost revision {%s}', revision)
519
def _remove_deleted(self):
520
"""Remove deleted files from the working inventories.
522
This is done prior to taking the working inventory as the
523
basis for the new committed inventory.
525
This returns true if any files
526
*that existed in the basis inventory* were deleted.
527
Files that were added and deleted
528
in the working copy don't matter.
530
specific = self.specific_files
532
deleted_paths = set()
533
for path, ie in self.work_inv.iter_entries():
534
if is_inside_any(deleted_paths, path):
535
# The tree will delete the required ids recursively.
537
if specific and not is_inside_any(specific, path):
539
if not self.work_tree.has_filename(path):
540
deleted_paths.add(path)
541
self.reporter.missing(path)
542
deleted_ids.append(ie.file_id)
543
self.work_tree.unversion(deleted_ids)
545
def _populate_new_inv(self):
546
"""Build revision inventory.
548
This creates a new empty inventory. Depending on
549
which files are selected for commit, and what is present in the
550
current tree, the new inventory is populated. inventory entries
551
which are candidates for modification have their revision set to
552
None; inventory entries that are carried over untouched have their
553
revision set to their prior value.
555
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
556
# results to create a new inventory at the same time, which results
557
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
559
mutter("Selecting files for commit with filter %s", self.specific_files)
560
assert self.work_inv.root is not None
561
entries = self.work_inv.iter_entries()
562
if not self.builder.record_root_entry:
563
symbol_versioning.warn('CommitBuilders should support recording'
564
' the root entry as of bzr 0.10.', DeprecationWarning,
566
self.builder.new_inventory.add(self.basis_inv.root.copy())
568
self._emit_progress_update()
569
for path, new_ie in entries:
570
self._emit_progress_update()
571
file_id = new_ie.file_id
572
# mutter('check %s {%s}', path, file_id)
573
if (not self.specific_files or
574
is_inside_or_parent_of_any(self.specific_files, path)):
575
# mutter('%s selected for commit', path)
579
# mutter('%s not selected for commit', path)
580
if self.basis_inv.has_id(file_id):
581
ie = self.basis_inv[file_id].copy()
583
# this entry is new and not being committed
585
self.builder.record_entry_contents(ie, self.parent_invs,
586
path, self.work_tree)
587
# describe the nature of the change that has occurred relative to
588
# the basis inventory.
589
if (self.basis_inv.has_id(ie.file_id)):
590
basis_ie = self.basis_inv[ie.file_id]
593
change = ie.describe_change(basis_ie, ie)
594
if change in (InventoryEntry.RENAMED,
595
InventoryEntry.MODIFIED_AND_RENAMED):
596
old_path = self.basis_inv.id2path(ie.file_id)
597
self.reporter.renamed(change, old_path, path)
599
self.reporter.snapshot_change(change, path)
601
if not self.specific_files:
604
# ignore removals that don't match filespec
605
for path, new_ie in self.basis_inv.iter_entries():
606
if new_ie.file_id in self.work_inv:
608
if is_inside_any(self.specific_files, path):
612
self.builder.record_entry_contents(ie, self.parent_invs, path,
615
def _emit_progress_update(self):
616
"""Emit an update to the progress bar."""
617
self.pb.update("Committing", self.pb_count, self.pb_total)
620
def _report_deletes(self):
621
for path, ie in self.basis_inv.iter_entries():
622
if ie.file_id not in self.builder.new_inventory:
623
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
