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.
70
from cStringIO import StringIO
73
import bzrlib.errors as errors
74
from bzrlib.errors import (BzrError, PointlessCommit,
78
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
79
is_inside_or_parent_of_any,
80
quotefn, sha_file, split_lines)
81
from bzrlib.testament import Testament
82
from bzrlib.trace import mutter, note, warning
83
from bzrlib.xml5 import serializer_v5
84
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
85
from bzrlib import symbol_versioning
86
from bzrlib.symbol_versioning import (deprecated_passed,
89
from bzrlib.workingtree import WorkingTree
92
class NullCommitReporter(object):
93
"""I report on progress of a commit."""
95
def snapshot_change(self, change, path):
98
def completed(self, revno, rev_id):
101
def deleted(self, file_id):
104
def escaped(self, escape_count, message):
107
def missing(self, path):
110
def renamed(self, change, old_path, new_path):
114
class ReportCommitToLog(NullCommitReporter):
116
# this may be more useful if 'note' was replaced by an overridable
117
# method on self, which would allow more trivial subclassing.
118
# alternative, a callable could be passed in, allowing really trivial
119
# reuse for some uis. RBC 20060511
121
def snapshot_change(self, change, path):
122
if change == 'unchanged':
124
note("%s %s", change, path)
126
def completed(self, revno, rev_id):
127
note('Committed revision %d.', revno)
129
def deleted(self, file_id):
130
note('deleted %s', file_id)
132
def escaped(self, escape_count, message):
133
note("replaced %d control characters in message", escape_count)
135
def missing(self, path):
136
note('missing %s', path)
138
def renamed(self, change, old_path, new_path):
139
note('%s %s => %s', change, old_path, new_path)
142
class Commit(object):
143
"""Task of committing a new revision.
145
This is a MethodObject: it accumulates state as the commit is
146
prepared, and then it is discarded. It doesn't represent
147
historical revisions, just the act of recording a new one.
150
Modified to hold a list of files that have been deleted from
151
the working directory; these should be removed from the
157
if reporter is not None:
158
self.reporter = reporter
160
self.reporter = NullCommitReporter()
161
if config is not None:
167
branch=DEPRECATED_PARAMETER, message=None,
173
allow_pointless=True,
181
"""Commit working copy as a new revision.
183
branch -- the deprecated branch to commit to. New callers should pass in
186
message -- the commit message, a mandatory parameter
188
timestamp -- if not None, seconds-since-epoch for a
189
postdated/predated commit.
191
specific_files -- If true, commit only those files.
193
rev_id -- If set, use this as the new revision id.
194
Useful for test or import commands that need to tightly
195
control what revisions are assigned. If you duplicate
196
a revision id that exists elsewhere it is your own fault.
197
If null (default), a time/random revision id is generated.
199
allow_pointless -- If true (default), commit even if nothing
200
has changed and no merges are recorded.
202
strict -- If true, don't allow a commit if the working tree
203
contains unknown files.
205
revprops -- Properties for new revision
206
:param local: Perform a local only commit.
208
mutter('preparing to commit')
210
if deprecated_passed(branch):
211
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
212
"deprecated as of bzr 0.8. Please use working_tree= instead.",
213
DeprecationWarning, stacklevel=2)
215
self.work_tree = self.branch.bzrdir.open_workingtree()
216
elif working_tree is None:
217
raise BzrError("One of branch and working_tree must be passed into commit().")
219
self.work_tree = working_tree
220
self.branch = self.work_tree.branch
222
raise BzrError("The message keyword parameter is required for commit().")
224
self.bound_branch = None
226
self.master_branch = None
227
self.master_locked = False
229
self.specific_files = specific_files
230
self.allow_pointless = allow_pointless
232
if reporter is None and self.reporter is None:
233
self.reporter = NullCommitReporter()
234
elif reporter is not None:
235
self.reporter = reporter
237
self.work_tree.lock_write()
238
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
240
# Cannot commit with conflicts present.
241
if len(self.work_tree.conflicts())>0:
242
raise ConflictsInTree
244
# setup the bound branch variables as needed.
245
self._check_bound_branch()
247
# check for out of date working trees
249
first_tree_parent = self.work_tree.get_parent_ids()[0]
251
# if there are no parents, treat our parent as 'None'
252
# this is so that we still consier the master branch
253
# - in a checkout scenario the tree may have no
254
# parents but the branch may do.
255
first_tree_parent = None
256
master_last = self.master_branch.last_revision()
257
if (master_last is not None and
258
master_last != first_tree_parent):
259
raise errors.OutOfDateTree(self.work_tree)
262
# raise an exception as soon as we find a single unknown.
263
for unknown in self.work_tree.unknowns():
264
raise StrictCommitFailed()
266
if self.config is None:
267
self.config = self.branch.get_config()
269
if isinstance(message, str):
270
message = message.decode(bzrlib.user_encoding)
271
assert isinstance(message, unicode), type(message)
272
self.message = message
273
self._escape_commit_message()
275
self.work_inv = self.work_tree.inventory
276
self.basis_tree = self.work_tree.basis_tree()
277
self.basis_inv = self.basis_tree.inventory
278
# one to finish, one for rev and inventory, and one for each
279
# inventory entry, and the same for the new inventory.
280
# note that this estimate is too long when we do a partial tree
281
# commit which excludes some new files from being considered.
282
# The estimate is corrected when we populate the new inv.
283
self.pb_total = len(self.work_inv) + 5
286
self._gather_parents()
287
if len(self.parents) > 1 and self.specific_files:
288
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
291
self.builder = self.branch.get_commit_builder(self.parents,
292
self.config, timestamp, timezone, committer, revprops, rev_id)
294
self._remove_deleted()
295
self._populate_new_inv()
296
self._report_deletes()
298
self._check_pointless()
300
self._emit_progress_update()
301
# TODO: Now the new inventory is known, check for conflicts and
302
# prompt the user for a commit message.
303
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
304
# weave lines, because nothing should be recorded until it is known
305
# that commit will succeed.
306
self.builder.finish_inventory()
307
self._emit_progress_update()
308
self.rev_id = self.builder.commit(self.message)
309
self._emit_progress_update()
310
# revision data is in the local branch now.
312
# upload revision data to the master.
313
# this will propagate merged revisions too if needed.
314
if self.bound_branch:
315
self.master_branch.repository.fetch(self.branch.repository,
316
revision_id=self.rev_id)
317
# now the master has the revision data
318
# 'commit' to the master first so a timeout here causes the local
319
# branch to be out of date
320
self.master_branch.append_revision(self.rev_id)
322
# and now do the commit locally.
323
self.branch.append_revision(self.rev_id)
325
# if the builder gave us the revisiontree it created back, we
326
# could use it straight away here.
327
# TODO: implement this.
328
self.work_tree.set_parent_trees([(self.rev_id,
329
self.branch.repository.revision_tree(self.rev_id))])
330
# now the work tree is up to date with the branch
332
self.reporter.completed(self.branch.revno(), self.rev_id)
333
if self.config.post_commit() is not None:
334
hooks = self.config.post_commit().split(' ')
335
# this would be nicer with twisted.python.reflect.namedAny
337
result = eval(hook + '(branch, rev_id)',
338
{'branch':self.branch,
340
'rev_id':self.rev_id})
341
self._emit_progress_update()
346
def _check_pointless(self):
347
if self.allow_pointless:
349
# A merge with no effect on files
350
if len(self.parents) > 1:
352
# work around the fact that a newly-initted tree does differ from its
354
if len(self.builder.new_inventory) != len(self.basis_inv):
356
if (len(self.builder.new_inventory) != 1 and
357
self.builder.new_inventory != self.basis_inv):
359
raise PointlessCommit()
361
def _check_bound_branch(self):
362
"""Check to see if the local branch is bound.
364
If it is bound, then most of the commit will actually be
365
done using the remote branch as the target branch.
366
Only at the end will the local branch be updated.
368
if self.local and not self.branch.get_bound_location():
369
raise errors.LocalRequiresBoundBranch()
372
self.master_branch = self.branch.get_master_branch()
374
if not self.master_branch:
375
# make this branch the reference branch for out of date checks.
376
self.master_branch = self.branch
379
# If the master branch is bound, we must fail
380
master_bound_location = self.master_branch.get_bound_location()
381
if master_bound_location:
382
raise errors.CommitToDoubleBoundBranch(self.branch,
383
self.master_branch, master_bound_location)
385
# TODO: jam 20051230 We could automatically push local
386
# commits to the remote branch if they would fit.
387
# But for now, just require remote to be identical
390
# Make sure the local branch is identical to the master
391
master_rh = self.master_branch.revision_history()
392
local_rh = self.branch.revision_history()
393
if local_rh != master_rh:
394
raise errors.BoundBranchOutOfDate(self.branch,
397
# Now things are ready to change the master branch
399
self.bound_branch = self.branch
400
self.master_branch.lock_write()
401
self.master_locked = True
404
"""Cleanup any open locks, progress bars etc."""
405
cleanups = [self._cleanup_bound_branch,
406
self.work_tree.unlock,
408
found_exception = None
409
for cleanup in cleanups:
412
# we want every cleanup to run no matter what.
413
# so we have a catchall here, but we will raise the
414
# last encountered exception up the stack: and
415
# typically this will be useful enough.
418
if found_exception is not None:
419
# don't do a plan raise, because the last exception may have been
420
# trashed, e is our sure-to-work exception even though it loses the
421
# full traceback. XXX: RBC 20060421 perhaps we could check the
422
# exc_info and if its the same one do a plain raise otherwise
423
# 'raise e' as we do now.
426
def _cleanup_bound_branch(self):
427
"""Executed at the end of a try/finally to cleanup a bound branch.
429
If the branch wasn't bound, this is a no-op.
430
If it was, it resents self.branch to the local branch, instead
433
if not self.bound_branch:
435
if self.master_locked:
436
self.master_branch.unlock()
438
def _escape_commit_message(self):
439
"""Replace xml-incompatible control characters."""
440
# FIXME: RBC 20060419 this should be done by the revision
441
# serialiser not by commit. Then we can also add an unescaper
442
# in the deserializer and start roundtripping revision messages
443
# precisely. See repository_implementations/test_repository.py
445
# Python strings can include characters that can't be
446
# represented in well-formed XML; escape characters that
447
# aren't listed in the XML specification
448
# (http://www.w3.org/TR/REC-xml/#NT-Char).
449
self.message, escape_count = re.subn(
450
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
451
lambda match: match.group(0).encode('unicode_escape'),
454
self.reporter.escaped(escape_count, self.message)
456
def _gather_parents(self):
457
"""Record the parents of a merge for merge detection."""
458
# TODO: Make sure that this list doesn't contain duplicate
459
# entries and the order is preserved when doing this.
460
self.parents = self.work_tree.get_parent_ids()
461
self.parent_invs = []
462
for revision in self.parents:
463
if self.branch.repository.has_revision(revision):
464
mutter('commit parent revision {%s}', revision)
465
inventory = self.branch.repository.get_inventory(revision)
466
self.parent_invs.append(inventory)
468
mutter('commit parent ghost revision {%s}', revision)
470
def _remove_deleted(self):
471
"""Remove deleted files from the working inventories.
473
This is done prior to taking the working inventory as the
474
basis for the new committed inventory.
476
This returns true if any files
477
*that existed in the basis inventory* were deleted.
478
Files that were added and deleted
479
in the working copy don't matter.
481
specific = self.specific_files
483
deleted_paths = set()
484
for path, ie in self.work_inv.iter_entries():
485
if is_inside_any(deleted_paths, path):
486
# The tree will delete the required ids recursively.
488
if specific and not is_inside_any(specific, path):
490
if not self.work_tree.has_filename(path):
491
deleted_paths.add(path)
492
self.reporter.missing(path)
493
deleted_ids.append(ie.file_id)
494
self.work_tree.unversion(deleted_ids)
496
def _populate_new_inv(self):
497
"""Build revision inventory.
499
This creates a new empty inventory. Depending on
500
which files are selected for commit, and what is present in the
501
current tree, the new inventory is populated. inventory entries
502
which are candidates for modification have their revision set to
503
None; inventory entries that are carried over untouched have their
504
revision set to their prior value.
506
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
507
# results to create a new inventory at the same time, which results
508
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
510
mutter("Selecting files for commit with filter %s", self.specific_files)
511
entries = self.work_inv.iter_entries()
512
if not self.builder.record_root_entry:
513
symbol_versioning.warn('CommitBuilders should support recording'
514
' the root entry as of bzr 0.10.', DeprecationWarning,
516
self.builder.new_inventory.add(self.basis_inv.root.copy())
518
self._emit_progress_update()
519
for path, new_ie in entries:
520
self._emit_progress_update()
521
file_id = new_ie.file_id
522
# mutter('check %s {%s}', path, file_id)
523
if (not self.specific_files or
524
is_inside_or_parent_of_any(self.specific_files, path)):
525
# mutter('%s selected for commit', path)
529
# mutter('%s not selected for commit', path)
530
if self.basis_inv.has_id(file_id):
531
ie = self.basis_inv[file_id].copy()
533
# this entry is new and not being committed
536
self.builder.record_entry_contents(ie, self.parent_invs,
537
path, self.work_tree)
538
# describe the nature of the change that has occurred relative to
539
# the basis inventory.
540
if (self.basis_inv.has_id(ie.file_id)):
541
basis_ie = self.basis_inv[ie.file_id]
544
change = ie.describe_change(basis_ie, ie)
545
if change in (InventoryEntry.RENAMED,
546
InventoryEntry.MODIFIED_AND_RENAMED):
547
old_path = self.basis_inv.id2path(ie.file_id)
548
self.reporter.renamed(change, old_path, path)
550
self.reporter.snapshot_change(change, path)
552
if not self.specific_files:
555
# ignore removals that don't match filespec
556
for path, new_ie in self.basis_inv.iter_entries():
557
if new_ie.file_id in self.work_inv:
559
if is_inside_any(self.specific_files, path):
563
self.builder.record_entry_contents(ie, self.parent_invs, path,
566
def _emit_progress_update(self):
567
"""Emit an update to the progress bar."""
568
self.pb.update("Committing", self.pb_count, self.pb_total)
571
def _report_deletes(self):
572
for path, ie in self.basis_inv.iter_entries():
573
if ie.file_id not in self.builder.new_inventory:
574
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
