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
19
# nothing? Perhaps the best approach is to integrate commit of
20
# AtomicFiles with releasing the lock on the Branch.
22
# TODO: Separate 'prepare' phase where we find a list of potentially
23
# committed files. We then can then pause the commit to prompt for a
24
# commit message, knowing the summary will be the same as what's
25
# actually used for the commit. (But perhaps simpler to simply get
26
# the tree status, then use that for a selective commit?)
28
# The newly committed revision is going to have a shape corresponding
29
# to that of the working inventory. Files that are not in the
30
# working tree and that were in the predecessor are reported as
31
# removed --- this can include files that were either removed from the
32
# inventory or deleted in the working tree. If they were only
33
# deleted from disk, they are removed from the working inventory.
35
# We then consider the remaining entries, which will be in the new
36
# version. Directory entries are simply copied across. File entries
37
# must be checked to see if a new version of the file should be
38
# recorded. For each parent revision inventory, we check to see what
39
# version of the file was present. If the file was present in at
40
# least one tree, and if it was the same version in all the trees,
41
# then we can just refer to that version. Otherwise, a new version
42
# representing the merger of the file versions must be added.
44
# TODO: Update hashcache before and after - or does the WorkingTree
47
# TODO: Rather than mashing together the ancestry and storing it back,
48
# perhaps the weave should have single method which does it all in one
49
# go, avoiding a lot of redundant work.
51
# TODO: Perhaps give a warning if one of the revisions marked as
52
# merged is already in the ancestry, and then don't record it as a
55
# TODO: If the file is newly merged but unchanged from the version it
56
# merges from, then it should still be reported as newly added
57
# relative to the basis revision.
59
# TODO: Do checks that the tree can be committed *before* running the
60
# editor; this should include checks for a pointless commit and for
61
# unknown or missing files.
63
# TODO: If commit fails, leave the message in a file somewhere.
72
from cStringIO import StringIO
74
from bzrlib.atomicfile import AtomicFile
76
import bzrlib.errors as errors
77
from bzrlib.errors import (BzrError, PointlessCommit,
81
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
82
is_inside_or_parent_of_any,
83
quotefn, sha_file, split_lines)
84
from bzrlib.testament import Testament
85
from bzrlib.trace import mutter, note, warning
86
from bzrlib.xml5 import serializer_v5
87
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
88
from bzrlib.symbol_versioning import *
89
from bzrlib.workingtree import WorkingTree
92
@deprecated_function(zero_seven)
93
def commit(*args, **kwargs):
94
"""Commit a new revision to a branch.
96
Function-style interface for convenience of old callers.
98
New code should use the Commit class instead.
100
## XXX: Remove this in favor of WorkingTree.commit?
101
Commit().commit(*args, **kwargs)
104
class NullCommitReporter(object):
105
"""I report on progress of a commit."""
107
def snapshot_change(self, change, path):
110
def completed(self, revno, rev_id):
113
def deleted(self, file_id):
116
def escaped(self, escape_count, message):
119
def missing(self, path):
122
def renamed(self, change, old_path, new_path):
126
class ReportCommitToLog(NullCommitReporter):
128
# this may be more useful if 'note' was replaced by an overridable
129
# method on self, which would allow more trivial subclassing.
130
# alternative, a callable could be passed in, allowing really trivial
131
# reuse for some uis. RBC 20060511
133
def snapshot_change(self, change, path):
134
if change == 'unchanged':
136
note("%s %s", change, path)
138
def completed(self, revno, rev_id):
139
note('Committed revision %d.', revno)
141
def deleted(self, file_id):
142
note('deleted %s', file_id)
144
def escaped(self, escape_count, message):
145
note("replaced %d control characters in message", escape_count)
147
def missing(self, path):
148
note('missing %s', path)
150
def renamed(self, change, old_path, new_path):
151
note('%s %s => %s', change, old_path, new_path)
154
class Commit(object):
155
"""Task of committing a new revision.
157
This is a MethodObject: it accumulates state as the commit is
158
prepared, and then it is discarded. It doesn't represent
159
historical revisions, just the act of recording a new one.
162
Modified to hold a list of files that have been deleted from
163
the working directory; these should be removed from the
169
if reporter is not None:
170
self.reporter = reporter
172
self.reporter = NullCommitReporter()
173
if config is not None:
179
branch=DEPRECATED_PARAMETER, message=None,
185
allow_pointless=True,
193
"""Commit working copy as a new revision.
195
branch -- the deprecated branch to commit to. New callers should pass in
198
message -- the commit message, a mandatory parameter
200
timestamp -- if not None, seconds-since-epoch for a
201
postdated/predated commit.
203
specific_files -- If true, commit only those files.
205
rev_id -- If set, use this as the new revision id.
206
Useful for test or import commands that need to tightly
207
control what revisions are assigned. If you duplicate
208
a revision id that exists elsewhere it is your own fault.
209
If null (default), a time/random revision id is generated.
211
allow_pointless -- If true (default), commit even if nothing
212
has changed and no merges are recorded.
214
strict -- If true, don't allow a commit if the working tree
215
contains unknown files.
217
revprops -- Properties for new revision
218
:param local: Perform a local only commit.
220
mutter('preparing to commit')
222
if deprecated_passed(branch):
223
warn("Commit.commit (branch, ...): The branch parameter is "
224
"deprecated as of bzr 0.8. Please use working_tree= instead.",
225
DeprecationWarning, stacklevel=2)
227
self.work_tree = self.branch.bzrdir.open_workingtree()
228
elif working_tree is None:
229
raise BzrError("One of branch and working_tree must be passed into commit().")
231
self.work_tree = working_tree
232
self.branch = self.work_tree.branch
234
raise BzrError("The message keyword parameter is required for commit().")
236
self.bound_branch = None
238
self.master_branch = None
239
self.master_locked = False
241
self.specific_files = specific_files
242
self.allow_pointless = allow_pointless
244
if reporter is None and self.reporter is None:
245
self.reporter = NullCommitReporter()
246
elif reporter is not None:
247
self.reporter = reporter
249
self.work_tree.lock_write()
250
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
252
# Cannot commit with conflicts present.
253
if len(self.work_tree.conflicts())>0:
254
raise ConflictsInTree
256
# setup the bound branch variables as needed.
257
self._check_bound_branch()
259
# check for out of date working trees
260
# if we are bound, then self.branch is the master branch and this
261
# test is thus all we need.
262
if self.work_tree.last_revision() != self.master_branch.last_revision():
263
raise errors.OutOfDateTree(self.work_tree)
266
# raise an exception as soon as we find a single unknown.
267
for unknown in self.work_tree.unknowns():
268
raise StrictCommitFailed()
270
if self.config is None:
271
self.config = bzrlib.config.BranchConfig(self.branch)
273
if isinstance(message, str):
274
message = message.decode(bzrlib.user_encoding)
275
assert isinstance(message, unicode), type(message)
276
self.message = message
277
self._escape_commit_message()
279
self.work_inv = self.work_tree.inventory
280
self.basis_tree = self.work_tree.basis_tree()
281
self.basis_inv = self.basis_tree.inventory
282
# one to finish, one for rev and inventory, and one for each
283
# inventory entry, and the same for the new inventory.
284
# note that this estimate is too long when we do a partial tree
285
# commit which excludes some new files from being considered.
286
# The estimate is corrected when we populate the new inv.
287
self.pb_total = len(self.work_inv) + 5
290
self._gather_parents()
291
if len(self.parents) > 1 and self.specific_files:
292
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
294
self._check_parents_present()
295
self.builder = self.branch.get_commit_builder(self.parents,
296
self.config, timestamp, timezone, committer, revprops, rev_id)
298
self._remove_deleted()
299
self._populate_new_inv()
300
self._report_deletes()
302
if not (self.allow_pointless
303
or len(self.parents) > 1
304
or self.builder.new_inventory != self.basis_inv):
305
raise PointlessCommit()
307
self._emit_progress_update()
308
# TODO: Now the new inventory is known, check for conflicts and prompt the
309
# user for a commit message.
310
self.builder.finish_inventory()
311
self._emit_progress_update()
312
self.rev_id = self.builder.commit(self.message)
313
self._emit_progress_update()
314
# revision data is in the local branch now.
316
# upload revision data to the master.
317
# this will propagate merged revisions too if needed.
318
if self.bound_branch:
319
self.master_branch.repository.fetch(self.branch.repository,
320
revision_id=self.rev_id)
321
# now the master has the revision data
322
# 'commit' to the master first so a timeout here causes the local
323
# branch to be out of date
324
self.master_branch.append_revision(self.rev_id)
326
# and now do the commit locally.
327
self.branch.append_revision(self.rev_id)
329
self.work_tree.set_pending_merges([])
330
self.work_tree.set_last_revision(self.rev_id)
331
# now the work tree is up to date with the branch
333
self.reporter.completed(self.branch.revno(), self.rev_id)
334
if self.config.post_commit() is not None:
335
hooks = self.config.post_commit().split(' ')
336
# this would be nicer with twisted.python.reflect.namedAny
338
result = eval(hook + '(branch, rev_id)',
339
{'branch':self.branch,
341
'rev_id':self.rev_id})
342
self._emit_progress_update()
347
def _check_bound_branch(self):
348
"""Check to see if the local branch is bound.
350
If it is bound, then most of the commit will actually be
351
done using the remote branch as the target branch.
352
Only at the end will the local branch be updated.
354
if self.local and not self.branch.get_bound_location():
355
raise errors.LocalRequiresBoundBranch()
358
self.master_branch = self.branch.get_master_branch()
360
if not self.master_branch:
361
# make this branch the reference branch for out of date checks.
362
self.master_branch = self.branch
365
# If the master branch is bound, we must fail
366
master_bound_location = self.master_branch.get_bound_location()
367
if master_bound_location:
368
raise errors.CommitToDoubleBoundBranch(self.branch,
369
self.master_branch, master_bound_location)
371
# TODO: jam 20051230 We could automatically push local
372
# commits to the remote branch if they would fit.
373
# But for now, just require remote to be identical
376
# Make sure the local branch is identical to the master
377
master_rh = self.master_branch.revision_history()
378
local_rh = self.branch.revision_history()
379
if local_rh != master_rh:
380
raise errors.BoundBranchOutOfDate(self.branch,
383
# Now things are ready to change the master branch
385
self.bound_branch = self.branch
386
self.master_branch.lock_write()
387
self.master_locked = True
390
"""Cleanup any open locks, progress bars etc."""
391
cleanups = [self._cleanup_bound_branch,
392
self.work_tree.unlock,
394
found_exception = None
395
for cleanup in cleanups:
398
# we want every cleanup to run no matter what.
399
# so we have a catchall here, but we will raise the
400
# last encountered exception up the stack: and
401
# typically this will be useful enough.
404
if found_exception is not None:
405
# don't do a plan raise, because the last exception may have been
406
# trashed, e is our sure-to-work exception even though it loses the
407
# full traceback. XXX: RBC 20060421 perhaps we could check the
408
# exc_info and if its the same one do a plain raise otherwise
409
# 'raise e' as we do now.
412
def _cleanup_bound_branch(self):
413
"""Executed at the end of a try/finally to cleanup a bound branch.
415
If the branch wasn't bound, this is a no-op.
416
If it was, it resents self.branch to the local branch, instead
419
if not self.bound_branch:
421
if self.master_locked:
422
self.master_branch.unlock()
424
def _escape_commit_message(self):
425
"""Replace xml-incompatible control characters."""
426
# FIXME: RBC 20060419 this should be done by the revision
427
# serialiser not by commit. Then we can also add an unescaper
428
# in the deserializer and start roundtripping revision messages
429
# precisely. See repository_implementations/test_repository.py
431
# Python strings can include characters that can't be
432
# represented in well-formed XML; escape characters that
433
# aren't listed in the XML specification
434
# (http://www.w3.org/TR/REC-xml/#NT-Char).
435
self.message, escape_count = re.subn(
436
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
437
lambda match: match.group(0).encode('unicode_escape'),
440
self.reporter.escaped(escape_count, self.message)
442
def _gather_parents(self):
443
"""Record the parents of a merge for merge detection."""
444
# TODO: Make sure that this list doesn't contain duplicate
445
# entries and the order is preserved when doing this.
446
self.parents = self.work_tree.get_parent_ids()
447
self.parent_invs = []
448
for revision in self.parents:
449
if self.branch.repository.has_revision(revision):
450
inventory = self.branch.repository.get_inventory(revision)
451
self.parent_invs.append(inventory)
453
def _check_parents_present(self):
454
for parent_id in self.parents:
455
mutter('commit parent revision {%s}', parent_id)
456
if not self.branch.repository.has_revision(parent_id):
457
if parent_id == self.branch.last_revision():
458
warning("parent is missing %r", parent_id)
459
raise BzrCheckError("branch %s is missing revision {%s}"
460
% (self.branch, parent_id))
462
def _remove_deleted(self):
463
"""Remove deleted files from the working inventories.
465
This is done prior to taking the working inventory as the
466
basis for the new committed inventory.
468
This returns true if any files
469
*that existed in the basis inventory* were deleted.
470
Files that were added and deleted
471
in the working copy don't matter.
473
specific = self.specific_files
475
for path, ie in self.work_inv.iter_entries():
476
if specific and not is_inside_any(specific, path):
478
if not self.work_tree.has_filename(path):
479
self.reporter.missing(path)
480
deleted_ids.append((path, ie.file_id))
482
deleted_ids.sort(reverse=True)
483
for path, file_id in deleted_ids:
484
del self.work_inv[file_id]
485
self.work_tree._write_inventory(self.work_inv)
487
def _populate_new_inv(self):
488
"""Build revision inventory.
490
This creates a new empty inventory. Depending on
491
which files are selected for commit, and what is present in the
492
current tree, the new inventory is populated. inventory entries
493
which are candidates for modification have their revision set to
494
None; inventory entries that are carried over untouched have their
495
revision set to their prior value.
497
mutter("Selecting files for commit with filter %s", self.specific_files)
498
# iter_entries does not visit the ROOT_ID node so we need to call
499
# self._emit_progress_update once by hand.
500
self._emit_progress_update()
501
for path, new_ie in self.work_inv.iter_entries():
502
self._emit_progress_update()
503
file_id = new_ie.file_id
504
mutter('check %s {%s}', path, file_id)
505
if (not self.specific_files or
506
is_inside_or_parent_of_any(self.specific_files, path)):
507
mutter('%s selected for commit', path)
511
mutter('%s not selected for commit', path)
512
if self.basis_inv.has_id(file_id):
513
ie = self.basis_inv[file_id].copy()
515
# this entry is new and not being committed
518
self.builder.record_entry_contents(ie, self.parent_invs,
519
path, self.work_tree)
520
# describe the nature of the change that has occurred relative to
521
# the basis inventory.
522
if (self.basis_inv.has_id(ie.file_id)):
523
basis_ie = self.basis_inv[ie.file_id]
526
change = ie.describe_change(basis_ie, ie)
527
if change in (InventoryEntry.RENAMED,
528
InventoryEntry.MODIFIED_AND_RENAMED):
529
old_path = self.basis_inv.id2path(ie.file_id)
530
self.reporter.renamed(change, old_path, path)
532
self.reporter.snapshot_change(change, path)
534
def _emit_progress_update(self):
535
"""Emit an update to the progress bar."""
536
self.pb.update("Committing", self.pb_count, self.pb_total)
539
def _report_deletes(self):
540
for path, ie in self.basis_inv.iter_entries():
541
if ie.file_id not in self.builder.new_inventory:
542
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
