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
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):
303
raise PointlessCommit()
305
self._emit_progress_update()
306
# TODO: Now the new inventory is known, check for conflicts and
307
# prompt the user for a commit message.
308
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
309
# weave lines, because nothing should be recorded until it is known
310
# that commit will succeed.
311
self.builder.finish_inventory()
312
self._emit_progress_update()
313
self.rev_id = self.builder.commit(self.message)
314
self._emit_progress_update()
315
# revision data is in the local branch now.
317
# upload revision data to the master.
318
# this will propagate merged revisions too if needed.
319
if self.bound_branch:
320
self.master_branch.repository.fetch(self.branch.repository,
321
revision_id=self.rev_id)
322
# now the master has the revision data
323
# 'commit' to the master first so a timeout here causes the local
324
# branch to be out of date
325
self.master_branch.append_revision(self.rev_id)
327
# and now do the commit locally.
328
self.branch.append_revision(self.rev_id)
330
# if the builder gave us the revisiontree it created back, we
331
# could use it straight away here.
332
# TODO: implement this.
333
self.work_tree.set_parent_trees([(self.rev_id,
334
self.branch.repository.revision_tree(self.rev_id))])
335
# now the work tree is up to date with the branch
337
self.reporter.completed(self.branch.revno(), self.rev_id)
338
if self.config.post_commit() is not None:
339
hooks = self.config.post_commit().split(' ')
340
# this would be nicer with twisted.python.reflect.namedAny
342
result = eval(hook + '(branch, rev_id)',
343
{'branch':self.branch,
345
'rev_id':self.rev_id})
346
self._emit_progress_update()
351
def _check_bound_branch(self):
352
"""Check to see if the local branch is bound.
354
If it is bound, then most of the commit will actually be
355
done using the remote branch as the target branch.
356
Only at the end will the local branch be updated.
358
if self.local and not self.branch.get_bound_location():
359
raise errors.LocalRequiresBoundBranch()
362
self.master_branch = self.branch.get_master_branch()
364
if not self.master_branch:
365
# make this branch the reference branch for out of date checks.
366
self.master_branch = self.branch
369
# If the master branch is bound, we must fail
370
master_bound_location = self.master_branch.get_bound_location()
371
if master_bound_location:
372
raise errors.CommitToDoubleBoundBranch(self.branch,
373
self.master_branch, master_bound_location)
375
# TODO: jam 20051230 We could automatically push local
376
# commits to the remote branch if they would fit.
377
# But for now, just require remote to be identical
380
# Make sure the local branch is identical to the master
381
master_rh = self.master_branch.revision_history()
382
local_rh = self.branch.revision_history()
383
if local_rh != master_rh:
384
raise errors.BoundBranchOutOfDate(self.branch,
387
# Now things are ready to change the master branch
389
self.bound_branch = self.branch
390
self.master_branch.lock_write()
391
self.master_locked = True
394
"""Cleanup any open locks, progress bars etc."""
395
cleanups = [self._cleanup_bound_branch,
396
self.work_tree.unlock,
398
found_exception = None
399
for cleanup in cleanups:
402
# we want every cleanup to run no matter what.
403
# so we have a catchall here, but we will raise the
404
# last encountered exception up the stack: and
405
# typically this will be useful enough.
408
if found_exception is not None:
409
# don't do a plan raise, because the last exception may have been
410
# trashed, e is our sure-to-work exception even though it loses the
411
# full traceback. XXX: RBC 20060421 perhaps we could check the
412
# exc_info and if its the same one do a plain raise otherwise
413
# 'raise e' as we do now.
416
def _cleanup_bound_branch(self):
417
"""Executed at the end of a try/finally to cleanup a bound branch.
419
If the branch wasn't bound, this is a no-op.
420
If it was, it resents self.branch to the local branch, instead
423
if not self.bound_branch:
425
if self.master_locked:
426
self.master_branch.unlock()
428
def _escape_commit_message(self):
429
"""Replace xml-incompatible control characters."""
430
# FIXME: RBC 20060419 this should be done by the revision
431
# serialiser not by commit. Then we can also add an unescaper
432
# in the deserializer and start roundtripping revision messages
433
# precisely. See repository_implementations/test_repository.py
435
# Python strings can include characters that can't be
436
# represented in well-formed XML; escape characters that
437
# aren't listed in the XML specification
438
# (http://www.w3.org/TR/REC-xml/#NT-Char).
439
self.message, escape_count = re.subn(
440
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
441
lambda match: match.group(0).encode('unicode_escape'),
444
self.reporter.escaped(escape_count, self.message)
446
def _gather_parents(self):
447
"""Record the parents of a merge for merge detection."""
448
# TODO: Make sure that this list doesn't contain duplicate
449
# entries and the order is preserved when doing this.
450
self.parents = self.work_tree.get_parent_ids()
451
self.parent_invs = []
452
for revision in self.parents:
453
if self.branch.repository.has_revision(revision):
454
mutter('commit parent revision {%s}', revision)
455
inventory = self.branch.repository.get_inventory(revision)
456
self.parent_invs.append(inventory)
458
mutter('commit parent ghost revision {%s}', revision)
460
def _remove_deleted(self):
461
"""Remove deleted files from the working inventories.
463
This is done prior to taking the working inventory as the
464
basis for the new committed inventory.
466
This returns true if any files
467
*that existed in the basis inventory* were deleted.
468
Files that were added and deleted
469
in the working copy don't matter.
471
specific = self.specific_files
473
deleted_paths = set()
474
for path, ie in self.work_inv.iter_entries():
475
if is_inside_any(deleted_paths, path):
476
# The tree will delete the required ids recursively.
478
if specific and not is_inside_any(specific, path):
480
if not self.work_tree.has_filename(path):
481
deleted_paths.add(path)
482
self.reporter.missing(path)
483
deleted_ids.append(ie.file_id)
484
self.work_tree.unversion(deleted_ids)
486
def _populate_new_inv(self):
487
"""Build revision inventory.
489
This creates a new empty inventory. Depending on
490
which files are selected for commit, and what is present in the
491
current tree, the new inventory is populated. inventory entries
492
which are candidates for modification have their revision set to
493
None; inventory entries that are carried over untouched have their
494
revision set to their prior value.
496
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
497
# results to create a new inventory at the same time, which results
498
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
500
mutter("Selecting files for commit with filter %s", self.specific_files)
501
entries = self.work_inv.iter_entries()
502
if not self.builder.record_root_entry:
503
symbol_versioning.warn('CommitBuilders should support recording'
504
' the root entry as of bzr 0.10.', DeprecationWarning,
506
self.builder.new_inventory.add(self.basis_inv.root.copy())
508
self._emit_progress_update()
509
for path, new_ie in entries:
510
self._emit_progress_update()
511
file_id = new_ie.file_id
512
# mutter('check %s {%s}', path, file_id)
513
if (not self.specific_files or
514
is_inside_or_parent_of_any(self.specific_files, path)):
515
# mutter('%s selected for commit', path)
519
# mutter('%s not selected for commit', path)
520
if self.basis_inv.has_id(file_id):
521
ie = self.basis_inv[file_id].copy()
523
# this entry is new and not being committed
526
self.builder.record_entry_contents(ie, self.parent_invs,
527
path, self.work_tree)
528
# describe the nature of the change that has occurred relative to
529
# the basis inventory.
530
if (self.basis_inv.has_id(ie.file_id)):
531
basis_ie = self.basis_inv[ie.file_id]
534
change = ie.describe_change(basis_ie, ie)
535
if change in (InventoryEntry.RENAMED,
536
InventoryEntry.MODIFIED_AND_RENAMED):
537
old_path = self.basis_inv.id2path(ie.file_id)
538
self.reporter.renamed(change, old_path, path)
540
self.reporter.snapshot_change(change, path)
542
if not self.specific_files:
545
# ignore removals that don't match filespec
546
for path, new_ie in self.basis_inv.iter_entries():
547
if new_ie.file_id in self.work_inv:
549
if is_inside_any(self.specific_files, path):
553
self.builder.record_entry_contents(ie, self.parent_invs, path,
556
def _emit_progress_update(self):
557
"""Emit an update to the progress bar."""
558
self.pb.update("Committing", self.pb_count, self.pb_total)
561
def _report_deletes(self):
562
for path, ie in self.basis_inv.iter_entries():
563
if ie.file_id not in self.builder.new_inventory:
564
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
