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
# The newly committed revision is going to have a shape corresponding
19
# to that of the working inventory. Files that are not in the
20
# working tree and that were in the predecessor are reported as
21
# removed --- this can include files that were either removed from the
22
# inventory or deleted in the working tree. If they were only
23
# deleted from disk, they are removed from the working inventory.
25
# We then consider the remaining entries, which will be in the new
26
# version. Directory entries are simply copied across. File entries
27
# must be checked to see if a new version of the file should be
28
# recorded. For each parent revision inventory, we check to see what
29
# version of the file was present. If the file was present in at
30
# least one tree, and if it was the same version in all the trees,
31
# then we can just refer to that version. Otherwise, a new version
32
# representing the merger of the file versions must be added.
34
# TODO: Update hashcache before and after - or does the WorkingTree
37
# TODO: Rather than mashing together the ancestry and storing it back,
38
# perhaps the weave should have single method which does it all in one
39
# go, avoiding a lot of redundant work.
41
# TODO: Perhaps give a warning if one of the revisions marked as
42
# merged is already in the ancestry, and then don't record it as a
45
# TODO: If the file is newly merged but unchanged from the version it
46
# merges from, then it should still be reported as newly added
47
# relative to the basis revision.
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
# the rest of the code; add a deprecation of the old name.
57
from cStringIO import StringIO
63
from bzrlib.branch import Branch
65
from bzrlib.errors import (BzrError, PointlessCommit,
69
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
70
is_inside_or_parent_of_any,
71
quotefn, sha_file, split_lines)
72
from bzrlib.testament import Testament
73
from bzrlib.trace import mutter, note, warning
74
from bzrlib.xml5 import serializer_v5
75
from bzrlib.inventory import Inventory, InventoryEntry
76
from bzrlib import symbol_versioning
77
from bzrlib.symbol_versioning import (deprecated_passed,
80
from bzrlib.workingtree import WorkingTree
84
class NullCommitReporter(object):
85
"""I report on progress of a commit."""
87
def snapshot_change(self, change, path):
90
def completed(self, revno, rev_id):
93
def deleted(self, file_id):
96
def escaped(self, escape_count, message):
99
def missing(self, path):
102
def renamed(self, change, old_path, new_path):
106
class ReportCommitToLog(NullCommitReporter):
108
# this may be more useful if 'note' was replaced by an overridable
109
# method on self, which would allow more trivial subclassing.
110
# alternative, a callable could be passed in, allowing really trivial
111
# reuse for some uis. RBC 20060511
113
def snapshot_change(self, change, path):
114
if change == 'unchanged':
116
if change == 'added' and path == '':
118
note("%s %s", change, path)
120
def completed(self, revno, rev_id):
121
note('Committed revision %d.', revno)
123
def deleted(self, file_id):
124
note('deleted %s', file_id)
126
def escaped(self, escape_count, message):
127
note("replaced %d control characters in message", escape_count)
129
def missing(self, path):
130
note('missing %s', path)
132
def renamed(self, change, old_path, new_path):
133
note('%s %s => %s', change, old_path, new_path)
136
class Commit(object):
137
"""Task of committing a new revision.
139
This is a MethodObject: it accumulates state as the commit is
140
prepared, and then it is discarded. It doesn't represent
141
historical revisions, just the act of recording a new one.
144
Modified to hold a list of files that have been deleted from
145
the working directory; these should be removed from the
151
if reporter is not None:
152
self.reporter = reporter
154
self.reporter = NullCommitReporter()
155
if config is not None:
161
branch=DEPRECATED_PARAMETER, message=None,
167
allow_pointless=True,
175
message_callback=None):
176
"""Commit working copy as a new revision.
178
branch -- the deprecated branch to commit to. New callers should pass in
181
message -- the commit message (it or message_callback is required)
183
timestamp -- if not None, seconds-since-epoch for a
184
postdated/predated commit.
186
specific_files -- If true, commit only those files.
188
rev_id -- If set, use this as the new revision id.
189
Useful for test or import commands that need to tightly
190
control what revisions are assigned. If you duplicate
191
a revision id that exists elsewhere it is your own fault.
192
If null (default), a time/random revision id is generated.
194
allow_pointless -- If true (default), commit even if nothing
195
has changed and no merges are recorded.
197
strict -- If true, don't allow a commit if the working tree
198
contains unknown files.
200
revprops -- Properties for new revision
201
:param local: Perform a local only commit.
203
mutter('preparing to commit')
205
if deprecated_passed(branch):
206
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
207
"deprecated as of bzr 0.8. Please use working_tree= instead.",
208
DeprecationWarning, stacklevel=2)
210
self.work_tree = self.branch.bzrdir.open_workingtree()
211
elif working_tree is None:
212
raise BzrError("One of branch and working_tree must be passed into commit().")
214
self.work_tree = working_tree
215
self.branch = self.work_tree.branch
216
if message_callback is None:
217
if message is not None:
218
if isinstance(message, str):
219
message = message.decode(bzrlib.user_encoding)
220
message_callback = lambda x: message
222
raise BzrError("The message or message_callback keyword"
223
" parameter is required for commit().")
225
self.bound_branch = None
227
self.master_branch = None
228
self.master_locked = False
230
self.specific_files = specific_files
231
self.allow_pointless = allow_pointless
233
if reporter is None and self.reporter is None:
234
self.reporter = NullCommitReporter()
235
elif reporter is not None:
236
self.reporter = reporter
238
self.work_tree.lock_write()
239
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
241
# Cannot commit with conflicts present.
242
if len(self.work_tree.conflicts())>0:
243
raise ConflictsInTree
245
# setup the bound branch variables as needed.
246
self._check_bound_branch()
248
# check for out of date working trees
250
first_tree_parent = self.work_tree.get_parent_ids()[0]
252
# if there are no parents, treat our parent as 'None'
253
# this is so that we still consier the master branch
254
# - in a checkout scenario the tree may have no
255
# parents but the branch may do.
256
first_tree_parent = None
257
master_last = self.master_branch.last_revision()
258
if (master_last is not None and
259
master_last != first_tree_parent):
260
raise errors.OutOfDateTree(self.work_tree)
263
# raise an exception as soon as we find a single unknown.
264
for unknown in self.work_tree.unknowns():
265
raise StrictCommitFailed()
267
if self.config is None:
268
self.config = self.branch.get_config()
270
self.work_inv = self.work_tree.inventory
271
self.basis_tree = self.work_tree.basis_tree()
272
self.basis_inv = self.basis_tree.inventory
273
if specific_files is not None:
274
# Ensure specified files are versioned
275
# (We don't actually need the ids here)
276
tree.find_ids_across_trees(specific_files,
277
[self.basis_tree, self.work_tree])
278
# one to finish, one for rev and inventory, and one for each
279
# inventory entry, and the same for the new inventory.
280
# note that this estimate is too long when we do a partial tree
281
# commit which excludes some new files from being considered.
282
# The estimate is corrected when we populate the new inv.
283
self.pb_total = len(self.work_inv) + 5
286
self._gather_parents()
287
if len(self.parents) > 1 and self.specific_files:
288
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
291
self.builder = self.branch.get_commit_builder(self.parents,
292
self.config, timestamp, timezone, committer, revprops, rev_id)
294
self._remove_deleted()
295
self._populate_new_inv()
296
self._report_deletes()
298
self._check_pointless()
300
self._emit_progress_update()
301
# TODO: Now the new inventory is known, check for conflicts and
302
# prompt the user for a commit message.
303
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
304
# weave lines, because nothing should be recorded until it is known
305
# that commit will succeed.
306
self.builder.finish_inventory()
307
self._emit_progress_update()
308
message = message_callback(self)
309
assert isinstance(message, unicode), type(message)
310
self.message = message
311
self._escape_commit_message()
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
rev_tree = self.builder.revision_tree()
331
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
332
# now the work tree is up to date with the branch
334
self.reporter.completed(self.branch.revno(), self.rev_id)
335
# old style commit hooks - should be deprecated ? (obsoleted in
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
# new style commit hooks:
346
if not self.bound_branch:
347
hook_master = self.branch
350
hook_master = self.master_branch
351
hook_local = self.branch
352
new_revno = self.branch.revno()
353
# With bound branches, when the master is behind the local branch,
354
# the 'old_revno' and old_revid values here are incorrect.
355
# XXX: FIXME ^. RBC 20060206
356
old_revno = new_revno - 1
358
old_revid = self.parents[0]
360
old_revid = bzrlib.revision.NULL_REVISION
361
for hook in Branch.hooks['post_commit']:
362
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
364
self._emit_progress_update()
369
def _any_real_changes(self):
370
"""Are there real changes between new_inventory and basis?
372
For trees without rich roots, inv.root.revision changes every commit.
373
But if that is the only change, we want to treat it as though there
376
new_entries = self.builder.new_inventory.iter_entries()
377
basis_entries = self.basis_inv.iter_entries()
378
new_path, new_root_ie = new_entries.next()
379
basis_path, basis_root_ie = basis_entries.next()
381
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
382
def ie_equal_no_revision(this, other):
383
return ((this.file_id == other.file_id)
384
and (this.name == other.name)
385
and (this.symlink_target == other.symlink_target)
386
and (this.text_sha1 == other.text_sha1)
387
and (this.text_size == other.text_size)
388
and (this.text_id == other.text_id)
389
and (this.parent_id == other.parent_id)
390
and (this.kind == other.kind)
391
and (this.executable == other.executable)
393
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
396
for new_ie, basis_ie in zip(new_entries, basis_entries):
397
if new_ie != basis_ie:
400
# No actual changes present
403
def _check_pointless(self):
404
if self.allow_pointless:
406
# A merge with no effect on files
407
if len(self.parents) > 1:
409
# work around the fact that a newly-initted tree does differ from its
411
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
412
raise PointlessCommit()
413
# Shortcut, if the number of entries changes, then we obviously have
415
if len(self.builder.new_inventory) != len(self.basis_inv):
417
# If length == 1, then we only have the root entry. Which means
418
# that there is no real difference (only the root could be different)
419
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
421
raise PointlessCommit()
423
def _check_bound_branch(self):
424
"""Check to see if the local branch is bound.
426
If it is bound, then most of the commit will actually be
427
done using the remote branch as the target branch.
428
Only at the end will the local branch be updated.
430
if self.local and not self.branch.get_bound_location():
431
raise errors.LocalRequiresBoundBranch()
434
self.master_branch = self.branch.get_master_branch()
436
if not self.master_branch:
437
# make this branch the reference branch for out of date checks.
438
self.master_branch = self.branch
441
# If the master branch is bound, we must fail
442
master_bound_location = self.master_branch.get_bound_location()
443
if master_bound_location:
444
raise errors.CommitToDoubleBoundBranch(self.branch,
445
self.master_branch, master_bound_location)
447
# TODO: jam 20051230 We could automatically push local
448
# commits to the remote branch if they would fit.
449
# But for now, just require remote to be identical
452
# Make sure the local branch is identical to the master
453
master_info = self.master_branch.last_revision_info()
454
local_info = self.branch.last_revision_info()
455
if local_info != master_info:
456
raise errors.BoundBranchOutOfDate(self.branch,
459
# Now things are ready to change the master branch
461
self.bound_branch = self.branch
462
self.master_branch.lock_write()
463
self.master_locked = True
466
"""Cleanup any open locks, progress bars etc."""
467
cleanups = [self._cleanup_bound_branch,
468
self.work_tree.unlock,
470
found_exception = None
471
for cleanup in cleanups:
474
# we want every cleanup to run no matter what.
475
# so we have a catchall here, but we will raise the
476
# last encountered exception up the stack: and
477
# typically this will be useful enough.
480
if found_exception is not None:
481
# don't do a plan raise, because the last exception may have been
482
# trashed, e is our sure-to-work exception even though it loses the
483
# full traceback. XXX: RBC 20060421 perhaps we could check the
484
# exc_info and if its the same one do a plain raise otherwise
485
# 'raise e' as we do now.
488
def _cleanup_bound_branch(self):
489
"""Executed at the end of a try/finally to cleanup a bound branch.
491
If the branch wasn't bound, this is a no-op.
492
If it was, it resents self.branch to the local branch, instead
495
if not self.bound_branch:
497
if self.master_locked:
498
self.master_branch.unlock()
500
def _escape_commit_message(self):
501
"""Replace xml-incompatible control characters."""
502
# FIXME: RBC 20060419 this should be done by the revision
503
# serialiser not by commit. Then we can also add an unescaper
504
# in the deserializer and start roundtripping revision messages
505
# precisely. See repository_implementations/test_repository.py
507
# Python strings can include characters that can't be
508
# represented in well-formed XML; escape characters that
509
# aren't listed in the XML specification
510
# (http://www.w3.org/TR/REC-xml/#NT-Char).
511
self.message, escape_count = re.subn(
512
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
513
lambda match: match.group(0).encode('unicode_escape'),
516
self.reporter.escaped(escape_count, self.message)
518
def _gather_parents(self):
519
"""Record the parents of a merge for merge detection."""
520
# TODO: Make sure that this list doesn't contain duplicate
521
# entries and the order is preserved when doing this.
522
self.parents = self.work_tree.get_parent_ids()
523
self.parent_invs = []
524
for revision in self.parents:
525
if self.branch.repository.has_revision(revision):
526
mutter('commit parent revision {%s}', revision)
527
inventory = self.branch.repository.get_inventory(revision)
528
self.parent_invs.append(inventory)
530
mutter('commit parent ghost revision {%s}', revision)
532
def _remove_deleted(self):
533
"""Remove deleted files from the working inventories.
535
This is done prior to taking the working inventory as the
536
basis for the new committed inventory.
538
This returns true if any files
539
*that existed in the basis inventory* were deleted.
540
Files that were added and deleted
541
in the working copy don't matter.
543
specific = self.specific_files
545
deleted_paths = set()
546
for path, ie in self.work_inv.iter_entries():
547
if is_inside_any(deleted_paths, path):
548
# The tree will delete the required ids recursively.
550
if specific and not is_inside_any(specific, path):
552
if not self.work_tree.has_filename(path):
553
deleted_paths.add(path)
554
self.reporter.missing(path)
555
deleted_ids.append(ie.file_id)
556
self.work_tree.unversion(deleted_ids)
558
def _populate_new_inv(self):
559
"""Build revision inventory.
561
This creates a new empty inventory. Depending on
562
which files are selected for commit, and what is present in the
563
current tree, the new inventory is populated. inventory entries
564
which are candidates for modification have their revision set to
565
None; inventory entries that are carried over untouched have their
566
revision set to their prior value.
568
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
569
# results to create a new inventory at the same time, which results
570
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
572
mutter("Selecting files for commit with filter %s", self.specific_files)
573
assert self.work_inv.root is not None
574
entries = self.work_inv.iter_entries()
575
if not self.builder.record_root_entry:
576
symbol_versioning.warn('CommitBuilders should support recording'
577
' the root entry as of bzr 0.10.', DeprecationWarning,
579
self.builder.new_inventory.add(self.basis_inv.root.copy())
581
self._emit_progress_update()
582
for path, new_ie in entries:
583
self._emit_progress_update()
584
file_id = new_ie.file_id
585
# mutter('check %s {%s}', path, file_id)
586
if (not self.specific_files or
587
is_inside_or_parent_of_any(self.specific_files, path)):
588
# mutter('%s selected for commit', path)
592
# mutter('%s not selected for commit', path)
593
if self.basis_inv.has_id(file_id):
594
ie = self.basis_inv[file_id].copy()
596
# this entry is new and not being committed
598
self.builder.record_entry_contents(ie, self.parent_invs,
599
path, self.work_tree)
600
# describe the nature of the change that has occurred relative to
601
# the basis inventory.
602
if (self.basis_inv.has_id(ie.file_id)):
603
basis_ie = self.basis_inv[ie.file_id]
606
change = ie.describe_change(basis_ie, ie)
607
if change in (InventoryEntry.RENAMED,
608
InventoryEntry.MODIFIED_AND_RENAMED):
609
old_path = self.basis_inv.id2path(ie.file_id)
610
self.reporter.renamed(change, old_path, path)
612
self.reporter.snapshot_change(change, path)
614
if not self.specific_files:
617
# ignore removals that don't match filespec
618
for path, new_ie in self.basis_inv.iter_entries():
619
if new_ie.file_id in self.work_inv:
621
if is_inside_any(self.specific_files, path):
625
self.builder.record_entry_contents(ie, self.parent_invs, path,
628
def _emit_progress_update(self):
629
"""Emit an update to the progress bar."""
630
self.pb.update("Committing", self.pb_count, self.pb_total)
633
def _report_deletes(self):
634
for path, ie in self.basis_inv.iter_entries():
635
if ie.file_id not in self.builder.new_inventory:
636
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
