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.
70
from cStringIO import StringIO
73
import bzrlib.errors as errors
74
from bzrlib.errors import (BzrError, PointlessCommit,
78
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
79
is_inside_or_parent_of_any,
80
quotefn, sha_file, split_lines)
81
from bzrlib.testament import Testament
82
from bzrlib.trace import mutter, note, warning
83
from bzrlib.xml5 import serializer_v5
84
from bzrlib.inventory import Inventory, InventoryEntry
85
from bzrlib import symbol_versioning
86
from bzrlib.symbol_versioning import (deprecated_passed,
89
from bzrlib.workingtree import WorkingTree
92
class NullCommitReporter(object):
93
"""I report on progress of a commit."""
95
def snapshot_change(self, change, path):
98
def completed(self, revno, rev_id):
101
def deleted(self, file_id):
104
def escaped(self, escape_count, message):
107
def missing(self, path):
110
def renamed(self, change, old_path, new_path):
114
class ReportCommitToLog(NullCommitReporter):
116
# this may be more useful if 'note' was replaced by an overridable
117
# method on self, which would allow more trivial subclassing.
118
# alternative, a callable could be passed in, allowing really trivial
119
# reuse for some uis. RBC 20060511
121
def snapshot_change(self, change, path):
122
if change == 'unchanged':
124
if change == 'added' and path == '':
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
251
first_tree_parent = self.work_tree.get_parent_ids()[0]
253
# if there are no parents, treat our parent as 'None'
254
# this is so that we still consier the master branch
255
# - in a checkout scenario the tree may have no
256
# parents but the branch may do.
257
first_tree_parent = None
258
master_last = self.master_branch.last_revision()
259
if (master_last is not None and
260
master_last != first_tree_parent):
261
raise errors.OutOfDateTree(self.work_tree)
264
# raise an exception as soon as we find a single unknown.
265
for unknown in self.work_tree.unknowns():
266
raise StrictCommitFailed()
268
if self.config is None:
269
self.config = self.branch.get_config()
271
if isinstance(message, str):
272
message = message.decode(bzrlib.user_encoding)
273
assert isinstance(message, unicode), type(message)
274
self.message = message
275
self._escape_commit_message()
277
self.work_inv = self.work_tree.inventory
278
self.basis_tree = self.work_tree.basis_tree()
279
self.basis_inv = self.basis_tree.inventory
280
# one to finish, one for rev and inventory, and one for each
281
# inventory entry, and the same for the new inventory.
282
# note that this estimate is too long when we do a partial tree
283
# commit which excludes some new files from being considered.
284
# The estimate is corrected when we populate the new inv.
285
self.pb_total = len(self.work_inv) + 5
288
self._gather_parents()
289
if len(self.parents) > 1 and self.specific_files:
290
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
293
self.builder = self.branch.get_commit_builder(self.parents,
294
self.config, timestamp, timezone, committer, revprops, rev_id)
296
self._remove_deleted()
297
self._populate_new_inv()
298
self._report_deletes()
300
if not (self.allow_pointless
301
or len(self.parents) > 1
302
or (self.builder.new_inventory != self.basis_inv and
303
(len(self.basis_inv) != 0 or
304
len(self.builder.new_inventory) > 1))):
305
raise PointlessCommit()
307
self._emit_progress_update()
308
# TODO: Now the new inventory is known, check for conflicts and
309
# prompt the user for a commit message.
310
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
311
# weave lines, because nothing should be recorded until it is known
312
# that commit will succeed.
313
self.builder.finish_inventory()
314
self._emit_progress_update()
315
self.rev_id = self.builder.commit(self.message)
316
self._emit_progress_update()
317
# revision data is in the local branch now.
319
# upload revision data to the master.
320
# this will propagate merged revisions too if needed.
321
if self.bound_branch:
322
self.master_branch.repository.fetch(self.branch.repository,
323
revision_id=self.rev_id)
324
# now the master has the revision data
325
# 'commit' to the master first so a timeout here causes the local
326
# branch to be out of date
327
self.master_branch.append_revision(self.rev_id)
329
# and now do the commit locally.
330
self.branch.append_revision(self.rev_id)
332
# if the builder gave us the revisiontree it created back, we
333
# could use it straight away here.
334
# TODO: implement this.
335
self.work_tree.set_parent_trees([(self.rev_id,
336
self.branch.repository.revision_tree(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
mutter('commit parent revision {%s}', revision)
457
inventory = self.branch.repository.get_inventory(revision)
458
self.parent_invs.append(inventory)
460
mutter('commit parent ghost revision {%s}', revision)
462
def _remove_deleted(self):
463
"""Remove deleted files from the working inventories.
465
This is done prior to taking the working inventory as the
466
basis for the new committed inventory.
468
This returns true if any files
469
*that existed in the basis inventory* were deleted.
470
Files that were added and deleted
471
in the working copy don't matter.
473
specific = self.specific_files
475
deleted_paths = set()
476
for path, ie in self.work_inv.iter_entries():
477
if is_inside_any(deleted_paths, path):
478
# The tree will delete the required ids recursively.
480
if specific and not is_inside_any(specific, path):
482
if not self.work_tree.has_filename(path):
483
deleted_paths.add(path)
484
self.reporter.missing(path)
485
deleted_ids.append(ie.file_id)
486
self.work_tree.unversion(deleted_ids)
488
def _populate_new_inv(self):
489
"""Build revision inventory.
491
This creates a new empty inventory. Depending on
492
which files are selected for commit, and what is present in the
493
current tree, the new inventory is populated. inventory entries
494
which are candidates for modification have their revision set to
495
None; inventory entries that are carried over untouched have their
496
revision set to their prior value.
498
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
499
# results to create a new inventory at the same time, which results
500
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
502
mutter("Selecting files for commit with filter %s", self.specific_files)
503
entries = self.work_inv.iter_entries()
504
if not self.builder.record_root_entry:
505
symbol_versioning.warn('CommitBuilders should support recording'
506
' the root entry as of bzr 0.10.', DeprecationWarning,
508
self.builder.new_inventory.add(self.basis_inv.root.copy())
510
self._emit_progress_update()
511
for path, new_ie in entries:
512
self._emit_progress_update()
513
file_id = new_ie.file_id
514
# mutter('check %s {%s}', path, file_id)
515
if (not self.specific_files or
516
is_inside_or_parent_of_any(self.specific_files, path)):
517
# mutter('%s selected for commit', path)
521
# mutter('%s not selected for commit', path)
522
if self.basis_inv.has_id(file_id):
523
ie = self.basis_inv[file_id].copy()
525
# this entry is new and not being committed
528
self.builder.record_entry_contents(ie, self.parent_invs,
529
path, self.work_tree)
532
raise repr((self.builder.new_inventory.root,
533
self.work_inv.root, ie))
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
