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, 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
if change == 'added' and path == '':
128
note("%s %s", change, path)
130
def completed(self, revno, rev_id):
131
note('Committed revision %d.', revno)
133
def deleted(self, file_id):
134
note('deleted %s', file_id)
136
def escaped(self, escape_count, message):
137
note("replaced %d control characters in message", escape_count)
139
def missing(self, path):
140
note('missing %s', path)
142
def renamed(self, change, old_path, new_path):
143
note('%s %s => %s', change, old_path, new_path)
146
class Commit(object):
147
"""Task of committing a new revision.
149
This is a MethodObject: it accumulates state as the commit is
150
prepared, and then it is discarded. It doesn't represent
151
historical revisions, just the act of recording a new one.
154
Modified to hold a list of files that have been deleted from
155
the working directory; these should be removed from the
161
if reporter is not None:
162
self.reporter = reporter
164
self.reporter = NullCommitReporter()
165
if config is not None:
171
branch=DEPRECATED_PARAMETER, message=None,
177
allow_pointless=True,
185
"""Commit working copy as a new revision.
187
branch -- the deprecated branch to commit to. New callers should pass in
190
message -- the commit message, a mandatory parameter
192
timestamp -- if not None, seconds-since-epoch for a
193
postdated/predated commit.
195
specific_files -- If true, commit only those files.
197
rev_id -- If set, use this as the new revision id.
198
Useful for test or import commands that need to tightly
199
control what revisions are assigned. If you duplicate
200
a revision id that exists elsewhere it is your own fault.
201
If null (default), a time/random revision id is generated.
203
allow_pointless -- If true (default), commit even if nothing
204
has changed and no merges are recorded.
206
strict -- If true, don't allow a commit if the working tree
207
contains unknown files.
209
revprops -- Properties for new revision
210
:param local: Perform a local only commit.
212
mutter('preparing to commit')
214
if deprecated_passed(branch):
215
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
216
"deprecated as of bzr 0.8. Please use working_tree= instead.",
217
DeprecationWarning, stacklevel=2)
219
self.work_tree = self.branch.bzrdir.open_workingtree()
220
elif working_tree is None:
221
raise BzrError("One of branch and working_tree must be passed into commit().")
223
self.work_tree = working_tree
224
self.branch = self.work_tree.branch
226
raise BzrError("The message keyword parameter is required for commit().")
228
self.bound_branch = None
230
self.master_branch = None
231
self.master_locked = False
233
self.specific_files = specific_files
234
self.allow_pointless = allow_pointless
236
if reporter is None and self.reporter is None:
237
self.reporter = NullCommitReporter()
238
elif reporter is not None:
239
self.reporter = reporter
241
self.work_tree.lock_write()
242
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
244
# Cannot commit with conflicts present.
245
if len(self.work_tree.conflicts())>0:
246
raise ConflictsInTree
248
# setup the bound branch variables as needed.
249
self._check_bound_branch()
251
# check for out of date working trees
253
first_tree_parent = self.work_tree.get_parent_ids()[0]
255
# if there are no parents, treat our parent as 'None'
256
# this is so that we still consier the master branch
257
# - in a checkout scenario the tree may have no
258
# parents but the branch may do.
259
first_tree_parent = None
260
master_last = self.master_branch.last_revision()
261
if (master_last is not None and
262
master_last != first_tree_parent):
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 = self.branch.get_config()
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',
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
self._check_pointless()
304
self._emit_progress_update()
305
# TODO: Now the new inventory is known, check for conflicts and
306
# prompt the user for a commit message.
307
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
308
# weave lines, because nothing should be recorded until it is known
309
# that commit will succeed.
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 propagate 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
# if the builder gave us the revisiontree it created back, we
330
# could use it straight away here.
331
# TODO: implement this.
332
self.work_tree.set_parent_trees([(self.rev_id,
333
self.branch.repository.revision_tree(self.rev_id))])
334
# now the work tree is up to date with the branch
336
self.reporter.completed(self.branch.revno(), self.rev_id)
337
if self.config.post_commit() is not None:
338
hooks = self.config.post_commit().split(' ')
339
# this would be nicer with twisted.python.reflect.namedAny
341
result = eval(hook + '(branch, rev_id)',
342
{'branch':self.branch,
344
'rev_id':self.rev_id})
345
self._emit_progress_update()
350
def _check_pointless(self):
351
if self.allow_pointless:
353
# A merge with no effect on files
354
if len(self.parents) > 1:
356
# work around the fact that a newly-initted tree does differ from its
358
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
359
raise PointlessCommit()
360
if len(self.builder.new_inventory) != len(self.basis_inv):
362
if (len(self.builder.new_inventory) != 1 and
363
self.builder.new_inventory != self.basis_inv):
365
raise PointlessCommit()
367
def _check_bound_branch(self):
368
"""Check to see if the local branch is bound.
370
If it is bound, then most of the commit will actually be
371
done using the remote branch as the target branch.
372
Only at the end will the local branch be updated.
374
if self.local and not self.branch.get_bound_location():
375
raise errors.LocalRequiresBoundBranch()
378
self.master_branch = self.branch.get_master_branch()
380
if not self.master_branch:
381
# make this branch the reference branch for out of date checks.
382
self.master_branch = self.branch
385
# If the master branch is bound, we must fail
386
master_bound_location = self.master_branch.get_bound_location()
387
if master_bound_location:
388
raise errors.CommitToDoubleBoundBranch(self.branch,
389
self.master_branch, master_bound_location)
391
# TODO: jam 20051230 We could automatically push local
392
# commits to the remote branch if they would fit.
393
# But for now, just require remote to be identical
396
# Make sure the local branch is identical to the master
397
master_rh = self.master_branch.revision_history()
398
local_rh = self.branch.revision_history()
399
if local_rh != master_rh:
400
raise errors.BoundBranchOutOfDate(self.branch,
403
# Now things are ready to change the master branch
405
self.bound_branch = self.branch
406
self.master_branch.lock_write()
407
self.master_locked = True
410
"""Cleanup any open locks, progress bars etc."""
411
cleanups = [self._cleanup_bound_branch,
412
self.work_tree.unlock,
414
found_exception = None
415
for cleanup in cleanups:
418
# we want every cleanup to run no matter what.
419
# so we have a catchall here, but we will raise the
420
# last encountered exception up the stack: and
421
# typically this will be useful enough.
424
if found_exception is not None:
425
# don't do a plan raise, because the last exception may have been
426
# trashed, e is our sure-to-work exception even though it loses the
427
# full traceback. XXX: RBC 20060421 perhaps we could check the
428
# exc_info and if its the same one do a plain raise otherwise
429
# 'raise e' as we do now.
432
def _cleanup_bound_branch(self):
433
"""Executed at the end of a try/finally to cleanup a bound branch.
435
If the branch wasn't bound, this is a no-op.
436
If it was, it resents self.branch to the local branch, instead
439
if not self.bound_branch:
441
if self.master_locked:
442
self.master_branch.unlock()
444
def _escape_commit_message(self):
445
"""Replace xml-incompatible control characters."""
446
# FIXME: RBC 20060419 this should be done by the revision
447
# serialiser not by commit. Then we can also add an unescaper
448
# in the deserializer and start roundtripping revision messages
449
# precisely. See repository_implementations/test_repository.py
451
# Python strings can include characters that can't be
452
# represented in well-formed XML; escape characters that
453
# aren't listed in the XML specification
454
# (http://www.w3.org/TR/REC-xml/#NT-Char).
455
self.message, escape_count = re.subn(
456
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
457
lambda match: match.group(0).encode('unicode_escape'),
460
self.reporter.escaped(escape_count, self.message)
462
def _gather_parents(self):
463
"""Record the parents of a merge for merge detection."""
464
# TODO: Make sure that this list doesn't contain duplicate
465
# entries and the order is preserved when doing this.
466
self.parents = self.work_tree.get_parent_ids()
467
self.parent_invs = []
468
for revision in self.parents:
469
if self.branch.repository.has_revision(revision):
470
mutter('commit parent revision {%s}', revision)
471
inventory = self.branch.repository.get_inventory(revision)
472
self.parent_invs.append(inventory)
474
mutter('commit parent ghost revision {%s}', revision)
476
def _remove_deleted(self):
477
"""Remove deleted files from the working inventories.
479
This is done prior to taking the working inventory as the
480
basis for the new committed inventory.
482
This returns true if any files
483
*that existed in the basis inventory* were deleted.
484
Files that were added and deleted
485
in the working copy don't matter.
487
specific = self.specific_files
489
deleted_paths = set()
490
for path, ie in self.work_inv.iter_entries():
491
if is_inside_any(deleted_paths, path):
492
# The tree will delete the required ids recursively.
494
if specific and not is_inside_any(specific, path):
496
if not self.work_tree.has_filename(path):
497
deleted_paths.add(path)
498
self.reporter.missing(path)
499
deleted_ids.append(ie.file_id)
500
self.work_tree.unversion(deleted_ids)
502
def _populate_new_inv(self):
503
"""Build revision inventory.
505
This creates a new empty inventory. Depending on
506
which files are selected for commit, and what is present in the
507
current tree, the new inventory is populated. inventory entries
508
which are candidates for modification have their revision set to
509
None; inventory entries that are carried over untouched have their
510
revision set to their prior value.
512
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
513
# results to create a new inventory at the same time, which results
514
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
516
mutter("Selecting files for commit with filter %s", self.specific_files)
517
entries = self.work_inv.iter_entries()
518
if not self.builder.record_root_entry:
519
symbol_versioning.warn('CommitBuilders should support recording'
520
' the root entry as of bzr 0.10.', DeprecationWarning,
522
self.builder.new_inventory.add(self.basis_inv.root.copy())
524
self._emit_progress_update()
525
for path, new_ie in entries:
526
self._emit_progress_update()
527
file_id = new_ie.file_id
528
# mutter('check %s {%s}', path, file_id)
529
if (not self.specific_files or
530
is_inside_or_parent_of_any(self.specific_files, path)):
531
# mutter('%s selected for commit', path)
535
# mutter('%s not selected for commit', path)
536
if self.basis_inv.has_id(file_id):
537
ie = self.basis_inv[file_id].copy()
539
# this entry is new and not being committed
542
self.builder.record_entry_contents(ie, self.parent_invs,
543
path, self.work_tree)
546
raise repr((self.builder.new_inventory.root,
547
self.work_inv.root, ie))
548
# describe the nature of the change that has occurred relative to
549
# the basis inventory.
550
if (self.basis_inv.has_id(ie.file_id)):
551
basis_ie = self.basis_inv[ie.file_id]
554
change = ie.describe_change(basis_ie, ie)
555
if change in (InventoryEntry.RENAMED,
556
InventoryEntry.MODIFIED_AND_RENAMED):
557
old_path = self.basis_inv.id2path(ie.file_id)
558
self.reporter.renamed(change, old_path, path)
560
self.reporter.snapshot_change(change, path)
562
if not self.specific_files:
565
# ignore removals that don't match filespec
566
for path, new_ie in self.basis_inv.iter_entries():
567
if new_ie.file_id in self.work_inv:
569
if is_inside_any(self.specific_files, path):
573
self.builder.record_entry_contents(ie, self.parent_invs, path,
576
def _emit_progress_update(self):
577
"""Emit an update to the progress bar."""
578
self.pb.update("Committing", self.pb_count, self.pb_total)
581
def _report_deletes(self):
582
for path, ie in self.basis_inv.iter_entries():
583
if ie.file_id not in self.builder.new_inventory:
584
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
