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 (deprecated_passed,
92
from bzrlib.workingtree import WorkingTree
95
@deprecated_function(zero_seven)
96
def commit(*args, **kwargs):
97
"""Commit a new revision to a branch.
99
Function-style interface for convenience of old callers.
101
New code should use the Commit class instead.
103
## XXX: Remove this in favor of WorkingTree.commit?
104
Commit().commit(*args, **kwargs)
107
class NullCommitReporter(object):
108
"""I report on progress of a commit."""
110
def snapshot_change(self, change, path):
113
def completed(self, revno, rev_id):
116
def deleted(self, file_id):
119
def escaped(self, escape_count, message):
122
def missing(self, path):
125
def renamed(self, change, old_path, new_path):
129
class ReportCommitToLog(NullCommitReporter):
131
# this may be more useful if 'note' was replaced by an overridable
132
# method on self, which would allow more trivial subclassing.
133
# alternative, a callable could be passed in, allowing really trivial
134
# reuse for some uis. RBC 20060511
136
def snapshot_change(self, change, path):
137
if change == 'unchanged':
139
note("%s %s", change, path)
141
def completed(self, revno, rev_id):
142
note('Committed revision %d.', revno)
144
def deleted(self, file_id):
145
note('deleted %s', file_id)
147
def escaped(self, escape_count, message):
148
note("replaced %d control characters in message", escape_count)
150
def missing(self, path):
151
note('missing %s', path)
153
def renamed(self, change, old_path, new_path):
154
note('%s %s => %s', change, old_path, new_path)
157
class Commit(object):
158
"""Task of committing a new revision.
160
This is a MethodObject: it accumulates state as the commit is
161
prepared, and then it is discarded. It doesn't represent
162
historical revisions, just the act of recording a new one.
165
Modified to hold a list of files that have been deleted from
166
the working directory; these should be removed from the
172
if reporter is not None:
173
self.reporter = reporter
175
self.reporter = NullCommitReporter()
176
if config is not None:
182
branch=DEPRECATED_PARAMETER, message=None,
188
allow_pointless=True,
196
"""Commit working copy as a new revision.
198
branch -- the deprecated branch to commit to. New callers should pass in
201
message -- the commit message, a mandatory parameter
203
timestamp -- if not None, seconds-since-epoch for a
204
postdated/predated commit.
206
specific_files -- If true, commit only those files.
208
rev_id -- If set, use this as the new revision id.
209
Useful for test or import commands that need to tightly
210
control what revisions are assigned. If you duplicate
211
a revision id that exists elsewhere it is your own fault.
212
If null (default), a time/random revision id is generated.
214
allow_pointless -- If true (default), commit even if nothing
215
has changed and no merges are recorded.
217
strict -- If true, don't allow a commit if the working tree
218
contains unknown files.
220
revprops -- Properties for new revision
221
:param local: Perform a local only commit.
223
mutter('preparing to commit')
225
if deprecated_passed(branch):
226
warnings.warn("Commit.commit (branch, ...): The branch parameter is "
227
"deprecated as of bzr 0.8. Please use working_tree= instead.",
228
DeprecationWarning, stacklevel=2)
230
self.work_tree = self.branch.bzrdir.open_workingtree()
231
elif working_tree is None:
232
raise BzrError("One of branch and working_tree must be passed into commit().")
234
self.work_tree = working_tree
235
self.branch = self.work_tree.branch
237
raise BzrError("The message keyword parameter is required for commit().")
239
self.bound_branch = None
241
self.master_branch = None
242
self.master_locked = False
244
self.specific_files = specific_files
245
self.allow_pointless = allow_pointless
247
if reporter is None and self.reporter is None:
248
self.reporter = NullCommitReporter()
249
elif reporter is not None:
250
self.reporter = reporter
252
self.work_tree.lock_write()
253
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
255
# Cannot commit with conflicts present.
256
if len(self.work_tree.conflicts())>0:
257
raise ConflictsInTree
259
# setup the bound branch variables as needed.
260
self._check_bound_branch()
262
# check for out of date working trees
263
# if we are bound, then self.branch is the master branch and this
264
# test is thus all we need.
265
if self.work_tree.last_revision() != self.master_branch.last_revision():
266
raise errors.OutOfDateTree(self.work_tree)
269
# raise an exception as soon as we find a single unknown.
270
for unknown in self.work_tree.unknowns():
271
raise StrictCommitFailed()
273
if self.config is None:
274
self.config = self.branch.get_config()
276
if isinstance(message, str):
277
message = message.decode(bzrlib.user_encoding)
278
assert isinstance(message, unicode), type(message)
279
self.message = message
280
self._escape_commit_message()
282
self.work_inv = self.work_tree.inventory
283
self.basis_tree = self.work_tree.basis_tree()
284
self.basis_inv = self.basis_tree.inventory
285
# one to finish, one for rev and inventory, and one for each
286
# inventory entry, and the same for the new inventory.
287
# note that this estimate is too long when we do a partial tree
288
# commit which excludes some new files from being considered.
289
# The estimate is corrected when we populate the new inv.
290
self.pb_total = len(self.work_inv) + 5
293
self._gather_parents()
294
if len(self.parents) > 1 and self.specific_files:
295
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
297
self._check_parents_present()
298
self.builder = self.branch.get_commit_builder(self.parents,
299
self.config, timestamp, timezone, committer, revprops, rev_id)
301
self._remove_deleted()
302
self._populate_new_inv()
303
self._report_deletes()
305
if not (self.allow_pointless
306
or len(self.parents) > 1
307
or self.builder.new_inventory != self.basis_inv):
308
raise PointlessCommit()
310
self._emit_progress_update()
311
# TODO: Now the new inventory is known, check for conflicts and
312
# prompt the user for a commit message.
313
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
314
# weave lines, because nothing should be recorded until it is known
315
# that commit will succeed.
316
self.builder.finish_inventory()
317
self._emit_progress_update()
318
self.rev_id = self.builder.commit(self.message)
319
self._emit_progress_update()
320
# revision data is in the local branch now.
322
# upload revision data to the master.
323
# this will propagate merged revisions too if needed.
324
if self.bound_branch:
325
self.master_branch.repository.fetch(self.branch.repository,
326
revision_id=self.rev_id)
327
# now the master has the revision data
328
# 'commit' to the master first so a timeout here causes the local
329
# branch to be out of date
330
self.master_branch.append_revision(self.rev_id)
332
# and now do the commit locally.
333
self.branch.append_revision(self.rev_id)
335
self.work_tree.set_pending_merges([])
336
self.work_tree.set_last_revision(self.rev_id)
337
# now the work tree is up to date with the branch
339
self.reporter.completed(self.branch.revno(), self.rev_id)
340
if self.config.post_commit() is not None:
341
hooks = self.config.post_commit().split(' ')
342
# this would be nicer with twisted.python.reflect.namedAny
344
result = eval(hook + '(branch, rev_id)',
345
{'branch':self.branch,
347
'rev_id':self.rev_id})
348
self._emit_progress_update()
353
def _check_bound_branch(self):
354
"""Check to see if the local branch is bound.
356
If it is bound, then most of the commit will actually be
357
done using the remote branch as the target branch.
358
Only at the end will the local branch be updated.
360
if self.local and not self.branch.get_bound_location():
361
raise errors.LocalRequiresBoundBranch()
364
self.master_branch = self.branch.get_master_branch()
366
if not self.master_branch:
367
# make this branch the reference branch for out of date checks.
368
self.master_branch = self.branch
371
# If the master branch is bound, we must fail
372
master_bound_location = self.master_branch.get_bound_location()
373
if master_bound_location:
374
raise errors.CommitToDoubleBoundBranch(self.branch,
375
self.master_branch, master_bound_location)
377
# TODO: jam 20051230 We could automatically push local
378
# commits to the remote branch if they would fit.
379
# But for now, just require remote to be identical
382
# Make sure the local branch is identical to the master
383
master_rh = self.master_branch.revision_history()
384
local_rh = self.branch.revision_history()
385
if local_rh != master_rh:
386
raise errors.BoundBranchOutOfDate(self.branch,
389
# Now things are ready to change the master branch
391
self.bound_branch = self.branch
392
self.master_branch.lock_write()
393
self.master_locked = True
396
"""Cleanup any open locks, progress bars etc."""
397
cleanups = [self._cleanup_bound_branch,
398
self.work_tree.unlock,
400
found_exception = None
401
for cleanup in cleanups:
404
# we want every cleanup to run no matter what.
405
# so we have a catchall here, but we will raise the
406
# last encountered exception up the stack: and
407
# typically this will be useful enough.
410
if found_exception is not None:
411
# don't do a plan raise, because the last exception may have been
412
# trashed, e is our sure-to-work exception even though it loses the
413
# full traceback. XXX: RBC 20060421 perhaps we could check the
414
# exc_info and if its the same one do a plain raise otherwise
415
# 'raise e' as we do now.
418
def _cleanup_bound_branch(self):
419
"""Executed at the end of a try/finally to cleanup a bound branch.
421
If the branch wasn't bound, this is a no-op.
422
If it was, it resents self.branch to the local branch, instead
425
if not self.bound_branch:
427
if self.master_locked:
428
self.master_branch.unlock()
430
def _escape_commit_message(self):
431
"""Replace xml-incompatible control characters."""
432
# FIXME: RBC 20060419 this should be done by the revision
433
# serialiser not by commit. Then we can also add an unescaper
434
# in the deserializer and start roundtripping revision messages
435
# precisely. See repository_implementations/test_repository.py
437
# Python strings can include characters that can't be
438
# represented in well-formed XML; escape characters that
439
# aren't listed in the XML specification
440
# (http://www.w3.org/TR/REC-xml/#NT-Char).
441
self.message, escape_count = re.subn(
442
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
443
lambda match: match.group(0).encode('unicode_escape'),
446
self.reporter.escaped(escape_count, self.message)
448
def _gather_parents(self):
449
"""Record the parents of a merge for merge detection."""
450
# TODO: Make sure that this list doesn't contain duplicate
451
# entries and the order is preserved when doing this.
452
self.parents = self.work_tree.get_parent_ids()
453
self.parent_invs = []
454
for revision in self.parents:
455
if self.branch.repository.has_revision(revision):
456
inventory = self.branch.repository.get_inventory(revision)
457
self.parent_invs.append(inventory)
459
def _check_parents_present(self):
460
for parent_id in self.parents:
461
mutter('commit parent revision {%s}', parent_id)
462
if not self.branch.repository.has_revision(parent_id):
463
if parent_id == self.branch.last_revision():
464
warning("parent is missing %r", parent_id)
465
raise BzrCheckError("branch %s is missing revision {%s}"
466
% (self.branch, parent_id))
468
def _remove_deleted(self):
469
"""Remove deleted files from the working inventories.
471
This is done prior to taking the working inventory as the
472
basis for the new committed inventory.
474
This returns true if any files
475
*that existed in the basis inventory* were deleted.
476
Files that were added and deleted
477
in the working copy don't matter.
479
specific = self.specific_files
481
for path, ie in self.work_inv.iter_entries():
482
if specific and not is_inside_any(specific, path):
484
if not self.work_tree.has_filename(path):
485
self.reporter.missing(path)
486
deleted_ids.append((path, ie.file_id))
488
deleted_ids.sort(reverse=True)
489
for path, file_id in deleted_ids:
490
del self.work_inv[file_id]
491
self.work_tree._write_inventory(self.work_inv)
493
def _populate_new_inv(self):
494
"""Build revision inventory.
496
This creates a new empty inventory. Depending on
497
which files are selected for commit, and what is present in the
498
current tree, the new inventory is populated. inventory entries
499
which are candidates for modification have their revision set to
500
None; inventory entries that are carried over untouched have their
501
revision set to their prior value.
503
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
504
# results to create a new inventory at the same time, which results
505
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
507
mutter("Selecting files for commit with filter %s", self.specific_files)
508
entries = self.work_inv.iter_entries()
509
if not self.builder.record_root_entry:
510
warnings.warn('CommitBuilders should support recording the root'
511
' entry as of bzr 0.10.', DeprecationWarning, stacklevel=1)
512
self.builder.new_inventory.add(self.basis_inv.root.copy())
514
self._emit_progress_update()
515
for path, new_ie in entries:
516
self._emit_progress_update()
517
file_id = new_ie.file_id
518
# mutter('check %s {%s}', path, file_id)
519
if (not self.specific_files or
520
is_inside_or_parent_of_any(self.specific_files, path)):
521
# mutter('%s selected for commit', path)
525
# mutter('%s not selected for commit', path)
526
if self.basis_inv.has_id(file_id):
527
ie = self.basis_inv[file_id].copy()
529
# this entry is new and not being committed
532
self.builder.record_entry_contents(ie, self.parent_invs,
533
path, self.work_tree)
534
# describe the nature of the change that has occurred relative to
535
# the basis inventory.
536
if (self.basis_inv.has_id(ie.file_id)):
537
basis_ie = self.basis_inv[ie.file_id]
540
change = ie.describe_change(basis_ie, ie)
541
if change in (InventoryEntry.RENAMED,
542
InventoryEntry.MODIFIED_AND_RENAMED):
543
old_path = self.basis_inv.id2path(ie.file_id)
544
self.reporter.renamed(change, old_path, path)
546
self.reporter.snapshot_change(change, path)
548
if not self.specific_files:
551
# ignore removals that don't match filespec
552
for path, new_ie in self.basis_inv.iter_entries():
553
if new_ie.file_id in self.work_inv:
555
if is_inside_any(self.specific_files, path):
559
self.builder.record_entry_contents(ie, self.parent_invs, path,
562
def _emit_progress_update(self):
563
"""Emit an update to the progress bar."""
564
self.pb.update("Committing", self.pb_count, self.pb_total)
567
def _report_deletes(self):
568
for path, ie in self.basis_inv.iter_entries():
569
if ie.file_id not in self.builder.new_inventory:
570
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
