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.
64
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
65
# the rest of the code; add a deprecation of the old name.
72
from cStringIO import StringIO
75
import bzrlib.errors as errors
76
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 import symbol_versioning
88
from bzrlib.symbol_versioning import (deprecated_passed,
91
from bzrlib.workingtree import WorkingTree
94
class NullCommitReporter(object):
95
"""I report on progress of a commit."""
97
def snapshot_change(self, change, path):
100
def completed(self, revno, rev_id):
103
def deleted(self, file_id):
106
def escaped(self, escape_count, message):
109
def missing(self, path):
112
def renamed(self, change, old_path, new_path):
116
class ReportCommitToLog(NullCommitReporter):
118
# this may be more useful if 'note' was replaced by an overridable
119
# method on self, which would allow more trivial subclassing.
120
# alternative, a callable could be passed in, allowing really trivial
121
# reuse for some uis. RBC 20060511
123
def snapshot_change(self, change, path):
124
if change == 'unchanged':
126
note("%s %s", change, path)
128
def completed(self, revno, rev_id):
129
note('Committed revision %d.', revno)
131
def deleted(self, file_id):
132
note('deleted %s', file_id)
134
def escaped(self, escape_count, message):
135
note("replaced %d control characters in message", escape_count)
137
def missing(self, path):
138
note('missing %s', path)
140
def renamed(self, change, old_path, new_path):
141
note('%s %s => %s', change, old_path, new_path)
144
class Commit(object):
145
"""Task of committing a new revision.
147
This is a MethodObject: it accumulates state as the commit is
148
prepared, and then it is discarded. It doesn't represent
149
historical revisions, just the act of recording a new one.
152
Modified to hold a list of files that have been deleted from
153
the working directory; these should be removed from the
159
if reporter is not None:
160
self.reporter = reporter
162
self.reporter = NullCommitReporter()
163
if config is not None:
169
branch=DEPRECATED_PARAMETER, message=None,
175
allow_pointless=True,
183
"""Commit working copy as a new revision.
185
branch -- the deprecated branch to commit to. New callers should pass in
188
message -- the commit message, a mandatory parameter
190
timestamp -- if not None, seconds-since-epoch for a
191
postdated/predated commit.
193
specific_files -- If true, commit only those files.
195
rev_id -- If set, use this as the new revision id.
196
Useful for test or import commands that need to tightly
197
control what revisions are assigned. If you duplicate
198
a revision id that exists elsewhere it is your own fault.
199
If null (default), a time/random revision id is generated.
201
allow_pointless -- If true (default), commit even if nothing
202
has changed and no merges are recorded.
204
strict -- If true, don't allow a commit if the working tree
205
contains unknown files.
207
revprops -- Properties for new revision
208
:param local: Perform a local only commit.
210
mutter('preparing to commit')
212
if deprecated_passed(branch):
213
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
214
"deprecated as of bzr 0.8. Please use working_tree= instead.",
215
DeprecationWarning, stacklevel=2)
217
self.work_tree = self.branch.bzrdir.open_workingtree()
218
elif working_tree is None:
219
raise BzrError("One of branch and working_tree must be passed into commit().")
221
self.work_tree = working_tree
222
self.branch = self.work_tree.branch
224
raise BzrError("The message keyword parameter is required for commit().")
226
self.bound_branch = None
228
self.master_branch = None
229
self.master_locked = False
231
self.specific_files = specific_files
232
self.allow_pointless = allow_pointless
234
if reporter is None and self.reporter is None:
235
self.reporter = NullCommitReporter()
236
elif reporter is not None:
237
self.reporter = reporter
239
self.work_tree.lock_write()
240
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
242
# Cannot commit with conflicts present.
243
if len(self.work_tree.conflicts())>0:
244
raise ConflictsInTree
246
# setup the bound branch variables as needed.
247
self._check_bound_branch()
249
# check for out of date working trees
250
# if we are bound, then self.branch is the master branch and this
251
# test is thus all we need.
252
if self.work_tree.last_revision() != self.master_branch.last_revision():
253
raise errors.OutOfDateTree(self.work_tree)
256
# raise an exception as soon as we find a single unknown.
257
for unknown in self.work_tree.unknowns():
258
raise StrictCommitFailed()
260
if self.config is None:
261
self.config = self.branch.get_config()
263
if isinstance(message, str):
264
message = message.decode(bzrlib.user_encoding)
265
assert isinstance(message, unicode), type(message)
266
self.message = message
267
self._escape_commit_message()
269
self.work_inv = self.work_tree.inventory
270
self.basis_tree = self.work_tree.basis_tree()
271
self.basis_inv = self.basis_tree.inventory
272
# one to finish, one for rev and inventory, and one for each
273
# inventory entry, and the same for the new inventory.
274
# note that this estimate is too long when we do a partial tree
275
# commit which excludes some new files from being considered.
276
# The estimate is corrected when we populate the new inv.
277
self.pb_total = len(self.work_inv) + 5
280
self._gather_parents()
281
if len(self.parents) > 1 and self.specific_files:
282
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
284
self._check_parents_present()
285
self.builder = self.branch.get_commit_builder(self.parents,
286
self.config, timestamp, timezone, committer, revprops, rev_id)
288
self._remove_deleted()
289
self._populate_new_inv()
290
self._report_deletes()
292
if not (self.allow_pointless
293
or len(self.parents) > 1
294
or self.builder.new_inventory != self.basis_inv):
295
raise PointlessCommit()
297
self._emit_progress_update()
298
# TODO: Now the new inventory is known, check for conflicts and
299
# prompt the user for a commit message.
300
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
301
# weave lines, because nothing should be recorded until it is known
302
# that commit will succeed.
303
self.builder.finish_inventory()
304
self._emit_progress_update()
305
self.rev_id = self.builder.commit(self.message)
306
self._emit_progress_update()
307
# revision data is in the local branch now.
309
# upload revision data to the master.
310
# this will propagate merged revisions too if needed.
311
if self.bound_branch:
312
self.master_branch.repository.fetch(self.branch.repository,
313
revision_id=self.rev_id)
314
# now the master has the revision data
315
# 'commit' to the master first so a timeout here causes the local
316
# branch to be out of date
317
self.master_branch.append_revision(self.rev_id)
319
# and now do the commit locally.
320
self.branch.append_revision(self.rev_id)
322
self.work_tree.set_pending_merges([])
323
self.work_tree.set_last_revision(self.rev_id)
324
# now the work tree is up to date with the branch
326
self.reporter.completed(self.branch.revno(), self.rev_id)
327
if self.config.post_commit() is not None:
328
hooks = self.config.post_commit().split(' ')
329
# this would be nicer with twisted.python.reflect.namedAny
331
result = eval(hook + '(branch, rev_id)',
332
{'branch':self.branch,
334
'rev_id':self.rev_id})
335
self._emit_progress_update()
340
def _check_bound_branch(self):
341
"""Check to see if the local branch is bound.
343
If it is bound, then most of the commit will actually be
344
done using the remote branch as the target branch.
345
Only at the end will the local branch be updated.
347
if self.local and not self.branch.get_bound_location():
348
raise errors.LocalRequiresBoundBranch()
351
self.master_branch = self.branch.get_master_branch()
353
if not self.master_branch:
354
# make this branch the reference branch for out of date checks.
355
self.master_branch = self.branch
358
# If the master branch is bound, we must fail
359
master_bound_location = self.master_branch.get_bound_location()
360
if master_bound_location:
361
raise errors.CommitToDoubleBoundBranch(self.branch,
362
self.master_branch, master_bound_location)
364
# TODO: jam 20051230 We could automatically push local
365
# commits to the remote branch if they would fit.
366
# But for now, just require remote to be identical
369
# Make sure the local branch is identical to the master
370
master_rh = self.master_branch.revision_history()
371
local_rh = self.branch.revision_history()
372
if local_rh != master_rh:
373
raise errors.BoundBranchOutOfDate(self.branch,
376
# Now things are ready to change the master branch
378
self.bound_branch = self.branch
379
self.master_branch.lock_write()
380
self.master_locked = True
383
"""Cleanup any open locks, progress bars etc."""
384
cleanups = [self._cleanup_bound_branch,
385
self.work_tree.unlock,
387
found_exception = None
388
for cleanup in cleanups:
391
# we want every cleanup to run no matter what.
392
# so we have a catchall here, but we will raise the
393
# last encountered exception up the stack: and
394
# typically this will be useful enough.
397
if found_exception is not None:
398
# don't do a plan raise, because the last exception may have been
399
# trashed, e is our sure-to-work exception even though it loses the
400
# full traceback. XXX: RBC 20060421 perhaps we could check the
401
# exc_info and if its the same one do a plain raise otherwise
402
# 'raise e' as we do now.
405
def _cleanup_bound_branch(self):
406
"""Executed at the end of a try/finally to cleanup a bound branch.
408
If the branch wasn't bound, this is a no-op.
409
If it was, it resents self.branch to the local branch, instead
412
if not self.bound_branch:
414
if self.master_locked:
415
self.master_branch.unlock()
417
def _escape_commit_message(self):
418
"""Replace xml-incompatible control characters."""
419
# FIXME: RBC 20060419 this should be done by the revision
420
# serialiser not by commit. Then we can also add an unescaper
421
# in the deserializer and start roundtripping revision messages
422
# precisely. See repository_implementations/test_repository.py
424
# Python strings can include characters that can't be
425
# represented in well-formed XML; escape characters that
426
# aren't listed in the XML specification
427
# (http://www.w3.org/TR/REC-xml/#NT-Char).
428
self.message, escape_count = re.subn(
429
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
430
lambda match: match.group(0).encode('unicode_escape'),
433
self.reporter.escaped(escape_count, self.message)
435
def _gather_parents(self):
436
"""Record the parents of a merge for merge detection."""
437
# TODO: Make sure that this list doesn't contain duplicate
438
# entries and the order is preserved when doing this.
439
self.parents = self.work_tree.get_parent_ids()
440
self.parent_invs = []
441
for revision in self.parents:
442
if self.branch.repository.has_revision(revision):
443
inventory = self.branch.repository.get_inventory(revision)
444
self.parent_invs.append(inventory)
446
def _check_parents_present(self):
447
for parent_id in self.parents:
448
mutter('commit parent revision {%s}', parent_id)
449
if not self.branch.repository.has_revision(parent_id):
450
if parent_id == self.branch.last_revision():
451
warning("parent is missing %r", parent_id)
452
raise BzrCheckError("branch %s is missing revision {%s}"
453
% (self.branch, parent_id))
455
def _remove_deleted(self):
456
"""Remove deleted files from the working inventories.
458
This is done prior to taking the working inventory as the
459
basis for the new committed inventory.
461
This returns true if any files
462
*that existed in the basis inventory* were deleted.
463
Files that were added and deleted
464
in the working copy don't matter.
466
specific = self.specific_files
468
for path, ie in self.work_inv.iter_entries():
469
if specific and not is_inside_any(specific, path):
471
if not self.work_tree.has_filename(path):
472
self.reporter.missing(path)
473
deleted_ids.append((path, ie.file_id))
475
deleted_ids.sort(reverse=True)
476
for path, file_id in deleted_ids:
477
del self.work_inv[file_id]
478
self.work_tree._write_inventory(self.work_inv)
480
def _populate_new_inv(self):
481
"""Build revision inventory.
483
This creates a new empty inventory. Depending on
484
which files are selected for commit, and what is present in the
485
current tree, the new inventory is populated. inventory entries
486
which are candidates for modification have their revision set to
487
None; inventory entries that are carried over untouched have their
488
revision set to their prior value.
490
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
491
# results to create a new inventory at the same time, which results
492
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
494
mutter("Selecting files for commit with filter %s", self.specific_files)
495
entries = self.work_inv.iter_entries()
496
if not self.builder.record_root_entry:
497
symbol_versioning.warn('CommitBuilders should support recording'
498
' the root entry as of bzr 0.10.', DeprecationWarning,
500
self.builder.new_inventory.add(self.basis_inv.root.copy())
502
self._emit_progress_update()
503
for path, new_ie in 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
if not self.specific_files:
539
# ignore removals that don't match filespec
540
for path, new_ie in self.basis_inv.iter_entries():
541
if new_ie.file_id in self.work_inv:
543
if is_inside_any(self.specific_files, path):
547
self.builder.record_entry_contents(ie, self.parent_invs, path,
550
def _emit_progress_update(self):
551
"""Emit an update to the progress bar."""
552
self.pb.update("Committing", self.pb_count, self.pb_total)
555
def _report_deletes(self):
556
for path, ie in self.basis_inv.iter_entries():
557
if ie.file_id not in self.builder.new_inventory:
558
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
