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.
71
from cStringIO import StringIO
74
import bzrlib.errors as errors
75
from bzrlib.errors import (BzrError, PointlessCommit,
80
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
81
is_inside_or_parent_of_any,
82
quotefn, sha_file, split_lines)
83
from bzrlib.testament import Testament
84
from bzrlib.trace import mutter, note, warning
85
from bzrlib.xml5 import serializer_v5
86
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
87
from bzrlib.symbol_versioning import *
88
from bzrlib.workingtree import WorkingTree
91
@deprecated_function(zero_seven)
92
def commit(*args, **kwargs):
93
"""Commit a new revision to a branch.
95
Function-style interface for convenience of old callers.
97
New code should use the Commit class instead.
99
## XXX: Remove this in favor of Branch.commit?
100
Commit().commit(*args, **kwargs)
103
class NullCommitReporter(object):
104
"""I report on progress of a commit."""
106
def snapshot_change(self, change, path):
109
def completed(self, revno, rev_id):
112
def deleted(self, file_id):
115
def escaped(self, escape_count, message):
118
def missing(self, path):
121
def renamed(self, change, old_path, new_path):
125
class ReportCommitToLog(NullCommitReporter):
127
# this may be more useful if 'note' was replaced by an overridable
128
# method on self, which would allow more trivial subclassing.
129
# alternative, a callable could be passed in, allowing really trivial
130
# reuse for some uis. RBC 20060511
132
def snapshot_change(self, change, path):
133
if change == 'unchanged':
135
note("%s %s", change, path)
137
def completed(self, revno, rev_id):
138
note('Committed revision %d.', revno)
140
def deleted(self, file_id):
141
note('deleted %s', file_id)
143
def escaped(self, escape_count, message):
144
note("replaced %d control characters in message", escape_count)
146
def missing(self, path):
147
note('missing %s', path)
149
def renamed(self, change, old_path, new_path):
150
note('%s %s => %s', change, old_path, new_path)
153
class Commit(object):
154
"""Task of committing a new revision.
156
This is a MethodObject: it accumulates state as the commit is
157
prepared, and then it is discarded. It doesn't represent
158
historical revisions, just the act of recording a new one.
161
Modified to hold a list of files that have been deleted from
162
the working directory; these should be removed from the
168
if reporter is not None:
169
self.reporter = reporter
171
self.reporter = NullCommitReporter()
172
if config is not None:
178
branch=DEPRECATED_PARAMETER, message=None,
184
allow_pointless=True,
192
"""Commit working copy as a new revision.
194
branch -- the deprecated branch to commit to. New callers should pass in
197
message -- the commit message, a mandatory parameter
199
timestamp -- if not None, seconds-since-epoch for a
200
postdated/predated commit.
202
specific_files -- If true, commit only those files.
204
rev_id -- If set, use this as the new revision id.
205
Useful for test or import commands that need to tightly
206
control what revisions are assigned. If you duplicate
207
a revision id that exists elsewhere it is your own fault.
208
If null (default), a time/random revision id is generated.
210
allow_pointless -- If true (default), commit even if nothing
211
has changed and no merges are recorded.
213
strict -- If true, don't allow a commit if the working tree
214
contains unknown files.
216
revprops -- Properties for new revision
217
:param local: Perform a local only commit.
219
mutter('preparing to commit')
221
if deprecated_passed(branch):
222
warn("Commit.commit (branch, ...): The branch parameter is "
223
"deprecated as of bzr 0.8. Please use working_tree= instead.",
224
DeprecationWarning, stacklevel=2)
226
self.work_tree = self.branch.bzrdir.open_workingtree()
227
elif working_tree is None:
228
raise BzrError("One of branch and working_tree must be passed into commit().")
230
self.work_tree = working_tree
231
self.branch = self.work_tree.branch
233
raise BzrError("The message keyword parameter is required for commit().")
235
self.weave_store = self.branch.repository.weave_store
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 propogate 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()
346
def _check_bound_branch(self):
347
"""Check to see if the local branch is bound.
349
If it is bound, then most of the commit will actually be
350
done using the remote branch as the target branch.
351
Only at the end will the local branch be updated.
353
if self.local and not self.branch.get_bound_location():
354
raise errors.LocalRequiresBoundBranch()
357
self.master_branch = self.branch.get_master_branch()
359
if not self.master_branch:
360
# make this branch the reference branch for out of date checks.
361
self.master_branch = self.branch
364
# If the master branch is bound, we must fail
365
master_bound_location = self.master_branch.get_bound_location()
366
if master_bound_location:
367
raise errors.CommitToDoubleBoundBranch(self.branch,
368
self.master_branch, master_bound_location)
370
# TODO: jam 20051230 We could automatically push local
371
# commits to the remote branch if they would fit.
372
# But for now, just require remote to be identical
375
# Make sure the local branch is identical to the master
376
master_rh = self.master_branch.revision_history()
377
local_rh = self.branch.revision_history()
378
if local_rh != master_rh:
379
raise errors.BoundBranchOutOfDate(self.branch,
382
# Now things are ready to change the master branch
384
self.bound_branch = self.branch
385
self.master_branch.lock_write()
386
self.master_locked = True
388
#### # Check to see if we have any pending merges. If we do
389
#### # those need to be pushed into the master branch
390
#### pending_merges = self.work_tree.pending_merges()
391
#### if pending_merges:
392
#### for revision_id in pending_merges:
393
#### self.master_branch.repository.fetch(self.bound_branch.repository,
394
#### revision_id=revision_id)
397
"""Cleanup any open locks, progress bars etc."""
398
cleanups = [self._cleanup_bound_branch,
399
self.work_tree.unlock,
401
found_exception = None
402
for cleanup in cleanups:
405
# we want every cleanup to run no matter what.
406
# so we have a catchall here, but we will raise the
407
# last encountered exception up the stack: and
408
# typically this will be useful enough.
411
if found_exception is not None:
412
# dont do a plan raise, because the last exception may have been
413
# trashed, e is our sure-to-work exception even though it loses the
414
# full traceback. XXX: RBC 20060421 perhaps we could check the
415
# exc_info and if its the same one do a plain raise otherwise
416
# 'raise e' as we do now.
419
def _cleanup_bound_branch(self):
420
"""Executed at the end of a try/finally to cleanup a bound branch.
422
If the branch wasn't bound, this is a no-op.
423
If it was, it resents self.branch to the local branch, instead
426
if not self.bound_branch:
428
if self.master_locked:
429
self.master_branch.unlock()
431
def _escape_commit_message(self):
432
"""Replace xml-incompatible control characters."""
433
# FIXME: RBC 20060419 this should be done by the revision
434
# serialiser not by commit. Then we can also add an unescaper
435
# in the deserializer and start roundtripping revision messages
436
# precisely. See repository_implementations/test_repository.py
438
# Python strings can include characters that can't be
439
# represented in well-formed XML; escape characters that
440
# aren't listed in the XML specification
441
# (http://www.w3.org/TR/REC-xml/#NT-Char).
442
self.message, escape_count = re.subn(
443
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
444
lambda match: match.group(0).encode('unicode_escape'),
447
self.reporter.escaped(escape_count, self.message)
449
def _gather_parents(self):
450
"""Record the parents of a merge for merge detection."""
451
# TODO: Make sure that this list doesn't contain duplicate
452
# entries and the order is preserved when doing this.
453
pending_merges = self.work_tree.pending_merges()
455
self.parent_invs = []
456
precursor_id = self.branch.last_revision()
458
self.parents.append(precursor_id)
459
self.parents += pending_merges
460
for revision in self.parents:
461
if self.branch.repository.has_revision(revision):
462
inventory = self.branch.repository.get_inventory(revision)
463
self.parent_invs.append(inventory)
465
def _check_parents_present(self):
466
for parent_id in self.parents:
467
mutter('commit parent revision {%s}', parent_id)
468
if not self.branch.repository.has_revision(parent_id):
469
if parent_id == self.branch.last_revision():
470
warning("parent is missing %r", parent_id)
471
raise HistoryMissing(self.branch, 'revision', parent_id)
473
mutter("commit will ghost revision %r", parent_id)
475
def _remove_deleted(self):
476
"""Remove deleted files from the working inventories.
478
This is done prior to taking the working inventory as the
479
basis for the new committed inventory.
481
This returns true if any files
482
*that existed in the basis inventory* were deleted.
483
Files that were added and deleted
484
in the working copy don't matter.
486
specific = self.specific_files
488
for path, ie in self.work_inv.iter_entries():
489
if specific and not is_inside_any(specific, path):
491
if not self.work_tree.has_filename(path):
492
self.reporter.missing(path)
493
deleted_ids.append((path, ie.file_id))
495
deleted_ids.sort(reverse=True)
496
for path, file_id in deleted_ids:
497
del self.work_inv[file_id]
498
self.work_tree._write_inventory(self.work_inv)
500
def _populate_new_inv(self):
501
"""Build revision inventory.
503
This creates a new empty inventory. Depending on
504
which files are selected for commit, and what is present in the
505
current tree, the new inventory is populated. inventory entries
506
which are candidates for modification have their revision set to
507
None; inventory entries that are carried over untouched have their
508
revision set to their prior value.
510
mutter("Selecting files for commit with filter %s", self.specific_files)
511
# iter_entries does not visit the ROOT_ID node so we need to call
512
# self._emit_progress_update once by hand.
513
self._emit_progress_update()
514
for path, new_ie in self.work_inv.iter_entries():
515
self._emit_progress_update()
516
file_id = new_ie.file_id
517
mutter('check %s {%s}', path, file_id)
518
if (not self.specific_files or
519
is_inside_or_parent_of_any(self.specific_files, path)):
520
mutter('%s selected for commit', path)
524
mutter('%s not selected for commit', path)
525
if self.basis_inv.has_id(file_id):
526
ie = self.basis_inv[file_id].copy()
528
# this entry is new and not being committed
531
self.builder.record_entry_contents(ie, self.parent_invs,
532
path, self.work_tree)
533
# describe the nature of the change that has occured relative to
534
# the basis inventory.
535
if (self.basis_inv.has_id(ie.file_id)):
536
basis_ie = self.basis_inv[ie.file_id]
539
change = ie.describe_change(basis_ie, ie)
540
if change in (InventoryEntry.RENAMED,
541
InventoryEntry.MODIFIED_AND_RENAMED):
542
old_path = self.basis_inv.id2path(ie.file_id)
543
self.reporter.renamed(change, old_path, path)
545
self.reporter.snapshot_change(change, path)
547
def _emit_progress_update(self):
548
"""Emit an update to the progress bar."""
549
self.pb.update("Committing", self.pb_count, self.pb_total)
552
def _report_deletes(self):
553
for path, ie in self.basis_inv.iter_entries():
554
if ie.file_id not in self.builder.new_inventory:
555
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
