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,
82
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
83
is_inside_or_parent_of_any,
84
quotefn, sha_file, split_lines)
85
from bzrlib.testament import Testament
86
from bzrlib.trace import mutter, note, warning
87
from bzrlib.xml5 import serializer_v5
88
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
89
from bzrlib.symbol_versioning import *
90
from bzrlib.workingtree import WorkingTree
93
@deprecated_function(zero_seven)
94
def commit(*args, **kwargs):
95
"""Commit a new revision to a branch.
97
Function-style interface for convenience of old callers.
99
New code should use the Commit class instead.
101
## XXX: Remove this in favor of WorkingTree.commit?
102
Commit().commit(*args, **kwargs)
105
class NullCommitReporter(object):
106
"""I report on progress of a commit."""
108
def snapshot_change(self, change, path):
111
def completed(self, revno, rev_id):
114
def deleted(self, file_id):
117
def escaped(self, escape_count, message):
120
def missing(self, path):
123
def renamed(self, change, old_path, new_path):
127
class ReportCommitToLog(NullCommitReporter):
129
# this may be more useful if 'note' was replaced by an overridable
130
# method on self, which would allow more trivial subclassing.
131
# alternative, a callable could be passed in, allowing really trivial
132
# reuse for some uis. RBC 20060511
134
def snapshot_change(self, change, path):
135
if change == 'unchanged':
137
note("%s %s", change, path)
139
def completed(self, revno, rev_id):
140
note('Committed revision %d.', revno)
142
def deleted(self, file_id):
143
note('deleted %s', file_id)
145
def escaped(self, escape_count, message):
146
note("replaced %d control characters in message", escape_count)
148
def missing(self, path):
149
note('missing %s', path)
151
def renamed(self, change, old_path, new_path):
152
note('%s %s => %s', change, old_path, new_path)
155
class Commit(object):
156
"""Task of committing a new revision.
158
This is a MethodObject: it accumulates state as the commit is
159
prepared, and then it is discarded. It doesn't represent
160
historical revisions, just the act of recording a new one.
163
Modified to hold a list of files that have been deleted from
164
the working directory; these should be removed from the
170
if reporter is not None:
171
self.reporter = reporter
173
self.reporter = NullCommitReporter()
174
if config is not None:
180
branch=DEPRECATED_PARAMETER, message=None,
186
allow_pointless=True,
194
"""Commit working copy as a new revision.
196
branch -- the deprecated branch to commit to. New callers should pass in
199
message -- the commit message, a mandatory parameter
201
timestamp -- if not None, seconds-since-epoch for a
202
postdated/predated commit.
204
specific_files -- If true, commit only those files.
206
rev_id -- If set, use this as the new revision id.
207
Useful for test or import commands that need to tightly
208
control what revisions are assigned. If you duplicate
209
a revision id that exists elsewhere it is your own fault.
210
If null (default), a time/random revision id is generated.
212
allow_pointless -- If true (default), commit even if nothing
213
has changed and no merges are recorded.
215
strict -- If true, don't allow a commit if the working tree
216
contains unknown files.
218
revprops -- Properties for new revision
219
:param local: Perform a local only commit.
221
mutter('preparing to commit')
223
if deprecated_passed(branch):
224
warn("Commit.commit (branch, ...): The branch parameter is "
225
"deprecated as of bzr 0.8. Please use working_tree= instead.",
226
DeprecationWarning, stacklevel=2)
228
self.work_tree = self.branch.bzrdir.open_workingtree()
229
elif working_tree is None:
230
raise BzrError("One of branch and working_tree must be passed into commit().")
232
self.work_tree = working_tree
233
self.branch = self.work_tree.branch
235
raise BzrError("The message keyword parameter is required for commit().")
237
self.bound_branch = None
239
self.master_branch = None
240
self.master_locked = False
242
self.specific_files = specific_files
243
self.allow_pointless = allow_pointless
245
if reporter is None and self.reporter is None:
246
self.reporter = NullCommitReporter()
247
elif reporter is not None:
248
self.reporter = reporter
250
self.work_tree.lock_write()
251
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
253
# Cannot commit with conflicts present.
254
if len(self.work_tree.conflicts())>0:
255
raise ConflictsInTree
257
# setup the bound branch variables as needed.
258
self._check_bound_branch()
260
# check for out of date working trees
261
# if we are bound, then self.branch is the master branch and this
262
# test is thus all we need.
263
if self.work_tree.last_revision() != self.master_branch.last_revision():
264
raise errors.OutOfDateTree(self.work_tree)
267
# raise an exception as soon as we find a single unknown.
268
for unknown in self.work_tree.unknowns():
269
raise StrictCommitFailed()
271
if self.config is None:
272
self.config = bzrlib.config.BranchConfig(self.branch)
274
if isinstance(message, str):
275
message = message.decode(bzrlib.user_encoding)
276
assert isinstance(message, unicode), type(message)
277
self.message = message
278
self._escape_commit_message()
280
self.work_inv = self.work_tree.inventory
281
self.basis_tree = self.work_tree.basis_tree()
282
self.basis_inv = self.basis_tree.inventory
283
# one to finish, one for rev and inventory, and one for each
284
# inventory entry, and the same for the new inventory.
285
# note that this estimate is too long when we do a partial tree
286
# commit which excludes some new files from being considered.
287
# The estimate is corrected when we populate the new inv.
288
self.pb_total = len(self.work_inv) + 5
291
self._gather_parents()
292
if len(self.parents) > 1 and self.specific_files:
293
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
295
self._check_parents_present()
296
self.builder = self.branch.get_commit_builder(self.parents,
297
self.config, timestamp, timezone, committer, revprops, rev_id)
299
self._remove_deleted()
300
self._populate_new_inv()
301
self._report_deletes()
303
if not (self.allow_pointless
304
or len(self.parents) > 1
305
or self.builder.new_inventory != self.basis_inv):
306
raise PointlessCommit()
308
self._emit_progress_update()
309
# TODO: Now the new inventory is known, check for conflicts and prompt the
310
# user for a commit message.
311
self.builder.finish_inventory()
312
self._emit_progress_update()
313
self.rev_id = self.builder.commit(self.message)
314
self._emit_progress_update()
315
# revision data is in the local branch now.
317
# upload revision data to the master.
318
# this will propagate merged revisions too if needed.
319
if self.bound_branch:
320
self.master_branch.repository.fetch(self.branch.repository,
321
revision_id=self.rev_id)
322
# now the master has the revision data
323
# 'commit' to the master first so a timeout here causes the local
324
# branch to be out of date
325
self.master_branch.append_revision(self.rev_id)
327
# and now do the commit locally.
328
self.branch.append_revision(self.rev_id)
330
self.work_tree.set_pending_merges([])
331
self.work_tree.set_last_revision(self.rev_id)
332
# now the work tree is up to date with the branch
334
self.reporter.completed(self.branch.revno(), self.rev_id)
335
if self.config.post_commit() is not None:
336
hooks = self.config.post_commit().split(' ')
337
# this would be nicer with twisted.python.reflect.namedAny
339
result = eval(hook + '(branch, rev_id)',
340
{'branch':self.branch,
342
'rev_id':self.rev_id})
343
self._emit_progress_update()
348
def _check_bound_branch(self):
349
"""Check to see if the local branch is bound.
351
If it is bound, then most of the commit will actually be
352
done using the remote branch as the target branch.
353
Only at the end will the local branch be updated.
355
if self.local and not self.branch.get_bound_location():
356
raise errors.LocalRequiresBoundBranch()
359
self.master_branch = self.branch.get_master_branch()
361
if not self.master_branch:
362
# make this branch the reference branch for out of date checks.
363
self.master_branch = self.branch
366
# If the master branch is bound, we must fail
367
master_bound_location = self.master_branch.get_bound_location()
368
if master_bound_location:
369
raise errors.CommitToDoubleBoundBranch(self.branch,
370
self.master_branch, master_bound_location)
372
# TODO: jam 20051230 We could automatically push local
373
# commits to the remote branch if they would fit.
374
# But for now, just require remote to be identical
377
# Make sure the local branch is identical to the master
378
master_rh = self.master_branch.revision_history()
379
local_rh = self.branch.revision_history()
380
if local_rh != master_rh:
381
raise errors.BoundBranchOutOfDate(self.branch,
384
# Now things are ready to change the master branch
386
self.bound_branch = self.branch
387
self.master_branch.lock_write()
388
self.master_locked = True
391
"""Cleanup any open locks, progress bars etc."""
392
cleanups = [self._cleanup_bound_branch,
393
self.work_tree.unlock,
395
found_exception = None
396
for cleanup in cleanups:
399
# we want every cleanup to run no matter what.
400
# so we have a catchall here, but we will raise the
401
# last encountered exception up the stack: and
402
# typically this will be useful enough.
405
if found_exception is not None:
406
# don't do a plan raise, because the last exception may have been
407
# trashed, e is our sure-to-work exception even though it loses the
408
# full traceback. XXX: RBC 20060421 perhaps we could check the
409
# exc_info and if its the same one do a plain raise otherwise
410
# 'raise e' as we do now.
413
def _cleanup_bound_branch(self):
414
"""Executed at the end of a try/finally to cleanup a bound branch.
416
If the branch wasn't bound, this is a no-op.
417
If it was, it resents self.branch to the local branch, instead
420
if not self.bound_branch:
422
if self.master_locked:
423
self.master_branch.unlock()
425
def _escape_commit_message(self):
426
"""Replace xml-incompatible control characters."""
427
# FIXME: RBC 20060419 this should be done by the revision
428
# serialiser not by commit. Then we can also add an unescaper
429
# in the deserializer and start roundtripping revision messages
430
# precisely. See repository_implementations/test_repository.py
432
# Python strings can include characters that can't be
433
# represented in well-formed XML; escape characters that
434
# aren't listed in the XML specification
435
# (http://www.w3.org/TR/REC-xml/#NT-Char).
436
self.message, escape_count = re.subn(
437
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
438
lambda match: match.group(0).encode('unicode_escape'),
441
self.reporter.escaped(escape_count, self.message)
443
def _gather_parents(self):
444
"""Record the parents of a merge for merge detection."""
445
# TODO: Make sure that this list doesn't contain duplicate
446
# entries and the order is preserved when doing this.
447
self.parents = self.work_tree.get_parent_ids()
448
self.parent_invs = []
449
for revision in self.parents:
450
if self.branch.repository.has_revision(revision):
451
inventory = self.branch.repository.get_inventory(revision)
452
self.parent_invs.append(inventory)
454
def _check_parents_present(self):
455
for parent_id in self.parents:
456
mutter('commit parent revision {%s}', parent_id)
457
if not self.branch.repository.has_revision(parent_id):
458
if parent_id == self.branch.last_revision():
459
warning("parent is missing %r", parent_id)
460
raise HistoryMissing(self.branch, 'revision', parent_id)
462
mutter("commit will ghost revision %r", parent_id)
464
def _remove_deleted(self):
465
"""Remove deleted files from the working inventories.
467
This is done prior to taking the working inventory as the
468
basis for the new committed inventory.
470
This returns true if any files
471
*that existed in the basis inventory* were deleted.
472
Files that were added and deleted
473
in the working copy don't matter.
475
specific = self.specific_files
477
for path, ie in self.work_inv.iter_entries():
478
if specific and not is_inside_any(specific, path):
480
if not self.work_tree.has_filename(path):
481
self.reporter.missing(path)
482
deleted_ids.append((path, ie.file_id))
484
deleted_ids.sort(reverse=True)
485
for path, file_id in deleted_ids:
486
del self.work_inv[file_id]
487
self.work_tree._write_inventory(self.work_inv)
489
def _populate_new_inv(self):
490
"""Build revision inventory.
492
This creates a new empty inventory. Depending on
493
which files are selected for commit, and what is present in the
494
current tree, the new inventory is populated. inventory entries
495
which are candidates for modification have their revision set to
496
None; inventory entries that are carried over untouched have their
497
revision set to their prior value.
499
mutter("Selecting files for commit with filter %s", self.specific_files)
500
# iter_entries does not visit the ROOT_ID node so we need to call
501
# self._emit_progress_update once by hand.
502
self._emit_progress_update()
503
for path, new_ie in self.work_inv.iter_entries():
504
self._emit_progress_update()
505
file_id = new_ie.file_id
506
mutter('check %s {%s}', path, file_id)
507
if (not self.specific_files or
508
is_inside_or_parent_of_any(self.specific_files, path)):
509
mutter('%s selected for commit', path)
513
mutter('%s not selected for commit', path)
514
if self.basis_inv.has_id(file_id):
515
ie = self.basis_inv[file_id].copy()
517
# this entry is new and not being committed
520
self.builder.record_entry_contents(ie, self.parent_invs,
521
path, self.work_tree)
522
# describe the nature of the change that has occurred relative to
523
# the basis inventory.
524
if (self.basis_inv.has_id(ie.file_id)):
525
basis_ie = self.basis_inv[ie.file_id]
528
change = ie.describe_change(basis_ie, ie)
529
if change in (InventoryEntry.RENAMED,
530
InventoryEntry.MODIFIED_AND_RENAMED):
531
old_path = self.basis_inv.id2path(ie.file_id)
532
self.reporter.renamed(change, old_path, path)
534
self.reporter.snapshot_change(change, path)
536
def _emit_progress_update(self):
537
"""Emit an update to the progress bar."""
538
self.pb.update("Committing", self.pb_count, self.pb_total)
541
def _report_deletes(self):
542
for path, ie in self.basis_inv.iter_entries():
543
if ie.file_id not in self.builder.new_inventory:
544
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
