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
79
from bzrlib.errors import (BzrError, PointlessCommit,
83
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
84
is_inside_or_parent_of_any,
85
quotefn, sha_file, split_lines)
86
from bzrlib.testament import Testament
87
from bzrlib.trace import mutter, note, warning
88
from bzrlib.xml5 import serializer_v5
89
from bzrlib.inventory import Inventory, InventoryEntry
90
from bzrlib import symbol_versioning
91
from bzrlib.symbol_versioning import (deprecated_passed,
94
from bzrlib.workingtree import WorkingTree
97
class NullCommitReporter(object):
98
"""I report on progress of a commit."""
100
def snapshot_change(self, change, path):
103
def completed(self, revno, rev_id):
106
def deleted(self, file_id):
109
def escaped(self, escape_count, message):
112
def missing(self, path):
115
def renamed(self, change, old_path, new_path):
119
class ReportCommitToLog(NullCommitReporter):
121
# this may be more useful if 'note' was replaced by an overridable
122
# method on self, which would allow more trivial subclassing.
123
# alternative, a callable could be passed in, allowing really trivial
124
# reuse for some uis. RBC 20060511
126
def snapshot_change(self, change, path):
127
if change == 'unchanged':
129
if change == 'added' and path == '':
131
note("%s %s", change, path)
133
def completed(self, revno, rev_id):
134
note('Committed revision %d.', revno)
136
def deleted(self, file_id):
137
note('deleted %s', file_id)
139
def escaped(self, escape_count, message):
140
note("replaced %d control characters in message", escape_count)
142
def missing(self, path):
143
note('missing %s', path)
145
def renamed(self, change, old_path, new_path):
146
note('%s %s => %s', change, old_path, new_path)
149
class Commit(object):
150
"""Task of committing a new revision.
152
This is a MethodObject: it accumulates state as the commit is
153
prepared, and then it is discarded. It doesn't represent
154
historical revisions, just the act of recording a new one.
157
Modified to hold a list of files that have been deleted from
158
the working directory; these should be removed from the
164
if reporter is not None:
165
self.reporter = reporter
167
self.reporter = NullCommitReporter()
168
if config is not None:
174
branch=DEPRECATED_PARAMETER, message=None,
180
allow_pointless=True,
188
"""Commit working copy as a new revision.
190
branch -- the deprecated branch to commit to. New callers should pass in
193
message -- the commit message, a mandatory parameter
195
timestamp -- if not None, seconds-since-epoch for a
196
postdated/predated commit.
198
specific_files -- If true, commit only those files.
200
rev_id -- If set, use this as the new revision id.
201
Useful for test or import commands that need to tightly
202
control what revisions are assigned. If you duplicate
203
a revision id that exists elsewhere it is your own fault.
204
If null (default), a time/random revision id is generated.
206
allow_pointless -- If true (default), commit even if nothing
207
has changed and no merges are recorded.
209
strict -- If true, don't allow a commit if the working tree
210
contains unknown files.
212
revprops -- Properties for new revision
213
:param local: Perform a local only commit.
215
mutter('preparing to commit')
217
if deprecated_passed(branch):
218
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
219
"deprecated as of bzr 0.8. Please use working_tree= instead.",
220
DeprecationWarning, stacklevel=2)
222
self.work_tree = self.branch.bzrdir.open_workingtree()
223
elif working_tree is None:
224
raise BzrError("One of branch and working_tree must be passed into commit().")
226
self.work_tree = working_tree
227
self.branch = self.work_tree.branch
229
raise BzrError("The message keyword parameter is required for commit().")
231
self.bound_branch = None
233
self.master_branch = None
234
self.master_locked = False
236
self.specific_files = specific_files
237
self.allow_pointless = allow_pointless
239
if reporter is None and self.reporter is None:
240
self.reporter = NullCommitReporter()
241
elif reporter is not None:
242
self.reporter = reporter
244
self.work_tree.lock_write()
245
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
247
# Cannot commit with conflicts present.
248
if len(self.work_tree.conflicts())>0:
249
raise ConflictsInTree
251
# setup the bound branch variables as needed.
252
self._check_bound_branch()
254
# check for out of date working trees
256
first_tree_parent = self.work_tree.get_parent_ids()[0]
258
# if there are no parents, treat our parent as 'None'
259
# this is so that we still consier the master branch
260
# - in a checkout scenario the tree may have no
261
# parents but the branch may do.
262
first_tree_parent = None
263
master_last = self.master_branch.last_revision()
264
if (master_last is not None and
265
master_last != first_tree_parent):
266
raise errors.OutOfDateTree(self.work_tree)
269
# raise an exception as soon as we find a single unknown.
270
for unknown in self.work_tree.unknowns():
271
raise StrictCommitFailed()
273
if self.config is None:
274
self.config = self.branch.get_config()
276
if isinstance(message, str):
277
message = message.decode(bzrlib.user_encoding)
278
assert isinstance(message, unicode), type(message)
279
self.message = message
280
self._escape_commit_message()
282
self.work_inv = self.work_tree.inventory
283
self.basis_tree = self.work_tree.basis_tree()
284
self.basis_inv = self.basis_tree.inventory
285
if specific_files is not None:
286
# Ensure specified files are versioned
287
# (We don't actually need the ids here)
288
tree.find_ids_across_trees(specific_files,
289
[self.basis_tree, self.work_tree])
290
# one to finish, one for rev and inventory, and one for each
291
# inventory entry, and the same for the new inventory.
292
# note that this estimate is too long when we do a partial tree
293
# commit which excludes some new files from being considered.
294
# The estimate is corrected when we populate the new inv.
295
self.pb_total = len(self.work_inv) + 5
298
self._gather_parents()
299
if len(self.parents) > 1 and self.specific_files:
300
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
303
self.builder = self.branch.get_commit_builder(self.parents,
304
self.config, timestamp, timezone, committer, revprops, rev_id)
306
self._remove_deleted()
307
self._populate_new_inv()
308
self._report_deletes()
310
self._check_pointless()
312
self._emit_progress_update()
313
# TODO: Now the new inventory is known, check for conflicts and
314
# prompt the user for a commit message.
315
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
316
# weave lines, because nothing should be recorded until it is known
317
# that commit will succeed.
318
self.builder.finish_inventory()
319
self._emit_progress_update()
320
self.rev_id = self.builder.commit(self.message)
321
self._emit_progress_update()
322
# revision data is in the local branch now.
324
# upload revision data to the master.
325
# this will propagate merged revisions too if needed.
326
if self.bound_branch:
327
self.master_branch.repository.fetch(self.branch.repository,
328
revision_id=self.rev_id)
329
# now the master has the revision data
330
# 'commit' to the master first so a timeout here causes the local
331
# branch to be out of date
332
self.master_branch.append_revision(self.rev_id)
334
# and now do the commit locally.
335
self.branch.append_revision(self.rev_id)
337
rev_tree = self.builder.revision_tree()
338
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
339
# now the work tree is up to date with the branch
341
self.reporter.completed(self.branch.revno(), self.rev_id)
342
if self.config.post_commit() is not None:
343
hooks = self.config.post_commit().split(' ')
344
# this would be nicer with twisted.python.reflect.namedAny
346
result = eval(hook + '(branch, rev_id)',
347
{'branch':self.branch,
349
'rev_id':self.rev_id})
350
self._emit_progress_update()
355
def _any_real_changes(self):
356
"""Are there real changes between new_inventory and basis?
358
For trees without rich roots, inv.root.revision changes every commit.
359
But if that is the only change, we want to treat it as though there
362
new_entries = self.builder.new_inventory.iter_entries()
363
basis_entries = self.basis_inv.iter_entries()
364
new_path, new_root_ie = new_entries.next()
365
basis_path, basis_root_ie = basis_entries.next()
367
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
368
def ie_equal_no_revision(this, other):
369
return ((this.file_id == other.file_id)
370
and (this.name == other.name)
371
and (this.symlink_target == other.symlink_target)
372
and (this.text_sha1 == other.text_sha1)
373
and (this.text_size == other.text_size)
374
and (this.text_id == other.text_id)
375
and (this.parent_id == other.parent_id)
376
and (this.kind == other.kind)
377
and (this.executable == other.executable)
379
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
382
for new_ie, basis_ie in zip(new_entries, basis_entries):
383
if new_ie != basis_ie:
386
# No actual changes present
389
def _check_pointless(self):
390
if self.allow_pointless:
392
# A merge with no effect on files
393
if len(self.parents) > 1:
395
# work around the fact that a newly-initted tree does differ from its
397
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
398
raise PointlessCommit()
399
# Shortcut, if the number of entries changes, then we obviously have
401
if len(self.builder.new_inventory) != len(self.basis_inv):
403
# If length == 1, then we only have the root entry. Which means
404
# that there is no real difference (only the root could be different)
405
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
407
raise PointlessCommit()
409
def _check_bound_branch(self):
410
"""Check to see if the local branch is bound.
412
If it is bound, then most of the commit will actually be
413
done using the remote branch as the target branch.
414
Only at the end will the local branch be updated.
416
if self.local and not self.branch.get_bound_location():
417
raise errors.LocalRequiresBoundBranch()
420
self.master_branch = self.branch.get_master_branch()
422
if not self.master_branch:
423
# make this branch the reference branch for out of date checks.
424
self.master_branch = self.branch
427
# If the master branch is bound, we must fail
428
master_bound_location = self.master_branch.get_bound_location()
429
if master_bound_location:
430
raise errors.CommitToDoubleBoundBranch(self.branch,
431
self.master_branch, master_bound_location)
433
# TODO: jam 20051230 We could automatically push local
434
# commits to the remote branch if they would fit.
435
# But for now, just require remote to be identical
438
# Make sure the local branch is identical to the master
439
master_rh = self.master_branch.revision_history()
440
local_rh = self.branch.revision_history()
441
if local_rh != master_rh:
442
raise errors.BoundBranchOutOfDate(self.branch,
445
# Now things are ready to change the master branch
447
self.bound_branch = self.branch
448
self.master_branch.lock_write()
449
self.master_locked = True
452
"""Cleanup any open locks, progress bars etc."""
453
cleanups = [self._cleanup_bound_branch,
454
self.work_tree.unlock,
456
found_exception = None
457
for cleanup in cleanups:
460
# we want every cleanup to run no matter what.
461
# so we have a catchall here, but we will raise the
462
# last encountered exception up the stack: and
463
# typically this will be useful enough.
466
if found_exception is not None:
467
# don't do a plan raise, because the last exception may have been
468
# trashed, e is our sure-to-work exception even though it loses the
469
# full traceback. XXX: RBC 20060421 perhaps we could check the
470
# exc_info and if its the same one do a plain raise otherwise
471
# 'raise e' as we do now.
474
def _cleanup_bound_branch(self):
475
"""Executed at the end of a try/finally to cleanup a bound branch.
477
If the branch wasn't bound, this is a no-op.
478
If it was, it resents self.branch to the local branch, instead
481
if not self.bound_branch:
483
if self.master_locked:
484
self.master_branch.unlock()
486
def _escape_commit_message(self):
487
"""Replace xml-incompatible control characters."""
488
# FIXME: RBC 20060419 this should be done by the revision
489
# serialiser not by commit. Then we can also add an unescaper
490
# in the deserializer and start roundtripping revision messages
491
# precisely. See repository_implementations/test_repository.py
493
# Python strings can include characters that can't be
494
# represented in well-formed XML; escape characters that
495
# aren't listed in the XML specification
496
# (http://www.w3.org/TR/REC-xml/#NT-Char).
497
self.message, escape_count = re.subn(
498
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
499
lambda match: match.group(0).encode('unicode_escape'),
502
self.reporter.escaped(escape_count, self.message)
504
def _gather_parents(self):
505
"""Record the parents of a merge for merge detection."""
506
# TODO: Make sure that this list doesn't contain duplicate
507
# entries and the order is preserved when doing this.
508
self.parents = self.work_tree.get_parent_ids()
509
self.parent_invs = []
510
for revision in self.parents:
511
if self.branch.repository.has_revision(revision):
512
mutter('commit parent revision {%s}', revision)
513
inventory = self.branch.repository.get_inventory(revision)
514
self.parent_invs.append(inventory)
516
mutter('commit parent ghost revision {%s}', revision)
518
def _remove_deleted(self):
519
"""Remove deleted files from the working inventories.
521
This is done prior to taking the working inventory as the
522
basis for the new committed inventory.
524
This returns true if any files
525
*that existed in the basis inventory* were deleted.
526
Files that were added and deleted
527
in the working copy don't matter.
529
specific = self.specific_files
531
deleted_paths = set()
532
for path, ie in self.work_inv.iter_entries():
533
if is_inside_any(deleted_paths, path):
534
# The tree will delete the required ids recursively.
536
if specific and not is_inside_any(specific, path):
538
if not self.work_tree.has_filename(path):
539
deleted_paths.add(path)
540
self.reporter.missing(path)
541
deleted_ids.append(ie.file_id)
542
self.work_tree.unversion(deleted_ids)
544
def _populate_new_inv(self):
545
"""Build revision inventory.
547
This creates a new empty inventory. Depending on
548
which files are selected for commit, and what is present in the
549
current tree, the new inventory is populated. inventory entries
550
which are candidates for modification have their revision set to
551
None; inventory entries that are carried over untouched have their
552
revision set to their prior value.
554
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
555
# results to create a new inventory at the same time, which results
556
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
558
mutter("Selecting files for commit with filter %s", self.specific_files)
559
assert self.work_inv.root is not None
560
entries = self.work_inv.iter_entries()
561
if not self.builder.record_root_entry:
562
symbol_versioning.warn('CommitBuilders should support recording'
563
' the root entry as of bzr 0.10.', DeprecationWarning,
565
self.builder.new_inventory.add(self.basis_inv.root.copy())
567
self._emit_progress_update()
568
for path, new_ie in entries:
569
self._emit_progress_update()
570
file_id = new_ie.file_id
571
# mutter('check %s {%s}', path, file_id)
572
if (not self.specific_files or
573
is_inside_or_parent_of_any(self.specific_files, path)):
574
# mutter('%s selected for commit', path)
578
# mutter('%s not selected for commit', path)
579
if self.basis_inv.has_id(file_id):
580
ie = self.basis_inv[file_id].copy()
582
# this entry is new and not being committed
584
self.builder.record_entry_contents(ie, self.parent_invs,
585
path, self.work_tree)
586
# describe the nature of the change that has occurred relative to
587
# the basis inventory.
588
if (self.basis_inv.has_id(ie.file_id)):
589
basis_ie = self.basis_inv[ie.file_id]
592
change = ie.describe_change(basis_ie, ie)
593
if change in (InventoryEntry.RENAMED,
594
InventoryEntry.MODIFIED_AND_RENAMED):
595
old_path = self.basis_inv.id2path(ie.file_id)
596
self.reporter.renamed(change, old_path, path)
598
self.reporter.snapshot_change(change, path)
600
if not self.specific_files:
603
# ignore removals that don't match filespec
604
for path, new_ie in self.basis_inv.iter_entries():
605
if new_ie.file_id in self.work_inv:
607
if is_inside_any(self.specific_files, path):
611
self.builder.record_entry_contents(ie, self.parent_invs, path,
614
def _emit_progress_update(self):
615
"""Emit an update to the progress bar."""
616
self.pb.update("Committing", self.pb_count, self.pb_total)
619
def _report_deletes(self):
620
for path, ie in self.basis_inv.iter_entries():
621
if ie.file_id not in self.builder.new_inventory:
622
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
