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 (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
warnings.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 = bzrlib.config.BranchConfig(self.branch)
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 prompt the
299
# user for a commit message.
300
self.builder.finish_inventory()
301
self._emit_progress_update()
302
self.rev_id = self.builder.commit(self.message)
303
self._emit_progress_update()
304
# revision data is in the local branch now.
306
# upload revision data to the master.
307
# this will propagate merged revisions too if needed.
308
if self.bound_branch:
309
self.master_branch.repository.fetch(self.branch.repository,
310
revision_id=self.rev_id)
311
# now the master has the revision data
312
# 'commit' to the master first so a timeout here causes the local
313
# branch to be out of date
314
self.master_branch.append_revision(self.rev_id)
316
# and now do the commit locally.
317
self.branch.append_revision(self.rev_id)
319
self.work_tree.set_pending_merges([])
320
self.work_tree.set_last_revision(self.rev_id)
321
# now the work tree is up to date with the branch
323
self.reporter.completed(self.branch.revno(), self.rev_id)
324
if self.config.post_commit() is not None:
325
hooks = self.config.post_commit().split(' ')
326
# this would be nicer with twisted.python.reflect.namedAny
328
result = eval(hook + '(branch, rev_id)',
329
{'branch':self.branch,
331
'rev_id':self.rev_id})
332
self._emit_progress_update()
336
def _check_bound_branch(self):
337
"""Check to see if the local branch is bound.
339
If it is bound, then most of the commit will actually be
340
done using the remote branch as the target branch.
341
Only at the end will the local branch be updated.
343
if self.local and not self.branch.get_bound_location():
344
raise errors.LocalRequiresBoundBranch()
347
self.master_branch = self.branch.get_master_branch()
349
if not self.master_branch:
350
# make this branch the reference branch for out of date checks.
351
self.master_branch = self.branch
354
# If the master branch is bound, we must fail
355
master_bound_location = self.master_branch.get_bound_location()
356
if master_bound_location:
357
raise errors.CommitToDoubleBoundBranch(self.branch,
358
self.master_branch, master_bound_location)
360
# TODO: jam 20051230 We could automatically push local
361
# commits to the remote branch if they would fit.
362
# But for now, just require remote to be identical
365
# Make sure the local branch is identical to the master
366
master_rh = self.master_branch.revision_history()
367
local_rh = self.branch.revision_history()
368
if local_rh != master_rh:
369
raise errors.BoundBranchOutOfDate(self.branch,
372
# Now things are ready to change the master branch
374
self.bound_branch = self.branch
375
self.master_branch.lock_write()
376
self.master_locked = True
378
#### # Check to see if we have any pending merges. If we do
379
#### # those need to be pushed into the master branch
380
#### pending_merges = self.work_tree.pending_merges()
381
#### if pending_merges:
382
#### for revision_id in pending_merges:
383
#### self.master_branch.repository.fetch(self.bound_branch.repository,
384
#### revision_id=revision_id)
387
"""Cleanup any open locks, progress bars etc."""
388
cleanups = [self._cleanup_bound_branch,
389
self.work_tree.unlock,
391
found_exception = None
392
for cleanup in cleanups:
395
# we want every cleanup to run no matter what.
396
# so we have a catchall here, but we will raise the
397
# last encountered exception up the stack: and
398
# typically this will be useful enough.
401
if found_exception is not None:
402
# don't do a plan raise, because the last exception may have been
403
# trashed, e is our sure-to-work exception even though it loses the
404
# full traceback. XXX: RBC 20060421 perhaps we could check the
405
# exc_info and if its the same one do a plain raise otherwise
406
# 'raise e' as we do now.
409
def _cleanup_bound_branch(self):
410
"""Executed at the end of a try/finally to cleanup a bound branch.
412
If the branch wasn't bound, this is a no-op.
413
If it was, it resents self.branch to the local branch, instead
416
if not self.bound_branch:
418
if self.master_locked:
419
self.master_branch.unlock()
421
def _escape_commit_message(self):
422
"""Replace xml-incompatible control characters."""
423
# FIXME: RBC 20060419 this should be done by the revision
424
# serialiser not by commit. Then we can also add an unescaper
425
# in the deserializer and start roundtripping revision messages
426
# precisely. See repository_implementations/test_repository.py
428
# Python strings can include characters that can't be
429
# represented in well-formed XML; escape characters that
430
# aren't listed in the XML specification
431
# (http://www.w3.org/TR/REC-xml/#NT-Char).
432
self.message, escape_count = re.subn(
433
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
434
lambda match: match.group(0).encode('unicode_escape'),
437
self.reporter.escaped(escape_count, self.message)
439
def _gather_parents(self):
440
"""Record the parents of a merge for merge detection."""
441
# TODO: Make sure that this list doesn't contain duplicate
442
# entries and the order is preserved when doing this.
443
pending_merges = self.work_tree.pending_merges()
445
self.parent_invs = []
446
precursor_id = self.branch.last_revision()
448
self.parents.append(precursor_id)
449
self.parents += pending_merges
450
for revision in self.parents:
451
if self.branch.repository.has_revision(revision):
452
inventory = self.branch.repository.get_inventory(revision)
453
self.parent_invs.append(inventory)
455
def _check_parents_present(self):
456
for parent_id in self.parents:
457
mutter('commit parent revision {%s}', parent_id)
458
if not self.branch.repository.has_revision(parent_id):
459
if parent_id == self.branch.last_revision():
460
warning("parent is missing %r", parent_id)
461
raise HistoryMissing(self.branch, 'revision', parent_id)
463
mutter("commit will ghost revision %r", parent_id)
465
def _remove_deleted(self):
466
"""Remove deleted files from the working inventories.
468
This is done prior to taking the working inventory as the
469
basis for the new committed inventory.
471
This returns true if any files
472
*that existed in the basis inventory* were deleted.
473
Files that were added and deleted
474
in the working copy don't matter.
476
specific = self.specific_files
478
for path, ie in self.work_inv.iter_entries():
479
if specific and not is_inside_any(specific, path):
481
if not self.work_tree.has_filename(path):
482
self.reporter.missing(path)
483
deleted_ids.append((path, ie.file_id))
485
deleted_ids.sort(reverse=True)
486
for path, file_id in deleted_ids:
487
del self.work_inv[file_id]
488
self.work_tree._write_inventory(self.work_inv)
490
def _populate_new_inv(self):
491
"""Build revision inventory.
493
This creates a new empty inventory. Depending on
494
which files are selected for commit, and what is present in the
495
current tree, the new inventory is populated. inventory entries
496
which are candidates for modification have their revision set to
497
None; inventory entries that are carried over untouched have their
498
revision set to their prior value.
500
mutter("Selecting files for commit with filter %s", self.specific_files)
501
# iter_entries does not visit the ROOT_ID node so we need to call
502
# self._emit_progress_update once by hand.
503
self._emit_progress_update()
504
for path, new_ie in self.work_inv.iter_entries():
505
self._emit_progress_update()
506
file_id = new_ie.file_id
507
mutter('check %s {%s}', path, file_id)
508
if (not self.specific_files or
509
is_inside_or_parent_of_any(self.specific_files, path)):
510
mutter('%s selected for commit', path)
514
mutter('%s not selected for commit', path)
515
if self.basis_inv.has_id(file_id):
516
ie = self.basis_inv[file_id].copy()
518
# this entry is new and not being committed
521
self.builder.record_entry_contents(ie, self.parent_invs,
522
path, self.work_tree)
523
# describe the nature of the change that has occurred relative to
524
# the basis inventory.
525
if (self.basis_inv.has_id(ie.file_id)):
526
basis_ie = self.basis_inv[ie.file_id]
529
change = ie.describe_change(basis_ie, ie)
530
if change in (InventoryEntry.RENAMED,
531
InventoryEntry.MODIFIED_AND_RENAMED):
532
old_path = self.basis_inv.id2path(ie.file_id)
533
self.reporter.renamed(change, old_path, path)
535
self.reporter.snapshot_change(change, path)
537
def _emit_progress_update(self):
538
"""Emit an update to the progress bar."""
539
self.pb.update("Committing", self.pb_count, self.pb_total)
542
def _report_deletes(self):
543
for path, ie in self.basis_inv.iter_entries():
544
if ie.file_id not in self.builder.new_inventory:
545
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
