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
64
from bzrlib.branch import Branch
66
from bzrlib.errors import (BzrError, PointlessCommit,
70
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
71
is_inside_or_parent_of_any,
72
quotefn, sha_file, split_lines)
73
from bzrlib.testament import Testament
74
from bzrlib.trace import mutter, note, warning
75
from bzrlib.xml5 import serializer_v5
76
from bzrlib.inventory import Inventory, InventoryEntry
77
from bzrlib import symbol_versioning
78
from bzrlib.symbol_versioning import (deprecated_passed,
81
from bzrlib.workingtree import WorkingTree
85
class NullCommitReporter(object):
86
"""I report on progress of a commit."""
88
def snapshot_change(self, change, path):
91
def completed(self, revno, rev_id):
94
def deleted(self, file_id):
97
def escaped(self, escape_count, message):
100
def missing(self, path):
103
def renamed(self, change, old_path, new_path):
107
class ReportCommitToLog(NullCommitReporter):
109
# this may be more useful if 'note' was replaced by an overridable
110
# method on self, which would allow more trivial subclassing.
111
# alternative, a callable could be passed in, allowing really trivial
112
# reuse for some uis. RBC 20060511
114
def snapshot_change(self, change, path):
115
if change == 'unchanged':
117
if change == 'added' and path == '':
119
note("%s %s", change, path)
121
def completed(self, revno, rev_id):
122
note('Committed revision %d.', revno)
124
def deleted(self, file_id):
125
note('deleted %s', file_id)
127
def escaped(self, escape_count, message):
128
note("replaced %d control characters in message", escape_count)
130
def missing(self, path):
131
note('missing %s', path)
133
def renamed(self, change, old_path, new_path):
134
note('%s %s => %s', change, old_path, new_path)
137
class Commit(object):
138
"""Task of committing a new revision.
140
This is a MethodObject: it accumulates state as the commit is
141
prepared, and then it is discarded. It doesn't represent
142
historical revisions, just the act of recording a new one.
145
Modified to hold a list of files that have been deleted from
146
the working directory; these should be removed from the
152
if reporter is not None:
153
self.reporter = reporter
155
self.reporter = NullCommitReporter()
156
if config is not None:
162
branch=DEPRECATED_PARAMETER, message=None,
168
allow_pointless=True,
176
message_callback=None):
177
"""Commit working copy as a new revision.
179
branch -- the deprecated branch to commit to. New callers should pass in
182
message -- the commit message (it or message_callback is required)
184
timestamp -- if not None, seconds-since-epoch for a
185
postdated/predated commit.
187
specific_files -- If true, commit only those files.
189
rev_id -- If set, use this as the new revision id.
190
Useful for test or import commands that need to tightly
191
control what revisions are assigned. If you duplicate
192
a revision id that exists elsewhere it is your own fault.
193
If null (default), a time/random revision id is generated.
195
allow_pointless -- If true (default), commit even if nothing
196
has changed and no merges are recorded.
198
strict -- If true, don't allow a commit if the working tree
199
contains unknown files.
201
revprops -- Properties for new revision
202
:param local: Perform a local only commit.
204
mutter('preparing to commit')
206
if deprecated_passed(branch):
207
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
208
"deprecated as of bzr 0.8. Please use working_tree= instead.",
209
DeprecationWarning, stacklevel=2)
211
self.work_tree = self.branch.bzrdir.open_workingtree()
212
elif working_tree is None:
213
raise BzrError("One of branch and working_tree must be passed into commit().")
215
self.work_tree = working_tree
216
self.branch = self.work_tree.branch
217
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
218
if not self.branch.repository.supports_rich_root():
219
raise errors.RootNotRich()
220
if message_callback is None:
221
if message is not None:
222
if isinstance(message, str):
223
message = message.decode(bzrlib.user_encoding)
224
message_callback = lambda x: message
226
raise BzrError("The message or message_callback keyword"
227
" parameter is required for commit().")
229
self.bound_branch = None
231
self.master_branch = None
232
self.master_locked = False
234
self.specific_files = specific_files
235
self.allow_pointless = allow_pointless
237
if reporter is None and self.reporter is None:
238
self.reporter = NullCommitReporter()
239
elif reporter is not None:
240
self.reporter = reporter
242
self.work_tree.lock_write()
243
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
244
self.basis_tree = self.work_tree.basis_tree()
245
self.basis_tree.lock_read()
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 = bzrlib.revision.NULL_REVISION
263
old_revno, master_last = self.master_branch.last_revision_info()
264
if master_last != first_tree_parent:
265
if master_last != bzrlib.revision.NULL_REVISION:
266
raise errors.OutOfDateTree(self.work_tree)
267
if self.branch.repository.has_revision(first_tree_parent):
268
new_revno = old_revno + 1
270
# ghost parents never appear in revision history.
273
# raise an exception as soon as we find a single unknown.
274
for unknown in self.work_tree.unknowns():
275
raise StrictCommitFailed()
277
if self.config is None:
278
self.config = self.branch.get_config()
280
self.work_inv = self.work_tree.inventory
281
self.basis_inv = self.basis_tree.inventory
282
if specific_files is not None:
283
# Ensure specified files are versioned
284
# (We don't actually need the ids here)
285
tree.find_ids_across_trees(specific_files,
286
[self.basis_tree, self.work_tree])
287
# one to finish, one for rev and inventory, and one for each
288
# inventory entry, and the same for the new inventory.
289
# note that this estimate is too long when we do a partial tree
290
# commit which excludes some new files from being considered.
291
# The estimate is corrected when we populate the new inv.
292
self.pb_total = len(self.work_inv) + 5
295
self._gather_parents()
296
if len(self.parents) > 1 and self.specific_files:
297
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
300
self.builder = self.branch.get_commit_builder(self.parents,
301
self.config, timestamp, timezone, committer, revprops, rev_id)
303
self._remove_deleted()
304
self._populate_new_inv()
305
self._report_deletes()
307
self._check_pointless()
309
self._emit_progress_update()
310
# TODO: Now the new inventory is known, check for conflicts and
311
# prompt the user for a commit message.
312
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
313
# weave lines, because nothing should be recorded until it is known
314
# that commit will succeed.
315
self.builder.finish_inventory()
316
self._emit_progress_update()
317
message = message_callback(self)
318
assert isinstance(message, unicode), type(message)
319
self.message = message
320
self._escape_commit_message()
322
self.rev_id = self.builder.commit(self.message)
323
self._emit_progress_update()
324
# revision data is in the local branch now.
326
# upload revision data to the master.
327
# this will propagate merged revisions too if needed.
328
if self.bound_branch:
329
self.master_branch.repository.fetch(self.branch.repository,
330
revision_id=self.rev_id)
331
# now the master has the revision data
332
# 'commit' to the master first so a timeout here causes the local
333
# branch to be out of date
334
self.master_branch.set_last_revision_info(new_revno,
337
# and now do the commit locally.
338
self.branch.set_last_revision_info(new_revno, self.rev_id)
340
rev_tree = self.builder.revision_tree()
341
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
342
# now the work tree is up to date with the branch
344
self.reporter.completed(new_revno, self.rev_id)
345
# old style commit hooks - should be deprecated ? (obsoleted in
347
if self.config.post_commit() is not None:
348
hooks = self.config.post_commit().split(' ')
349
# this would be nicer with twisted.python.reflect.namedAny
351
result = eval(hook + '(branch, rev_id)',
352
{'branch':self.branch,
354
'rev_id':self.rev_id})
355
# new style commit hooks:
356
if not self.bound_branch:
357
hook_master = self.branch
360
hook_master = self.master_branch
361
hook_local = self.branch
362
# With bound branches, when the master is behind the local branch,
363
# the 'old_revno' and old_revid values here are incorrect.
364
# XXX: FIXME ^. RBC 20060206
366
old_revid = self.parents[0]
368
old_revid = bzrlib.revision.NULL_REVISION
369
for hook in Branch.hooks['post_commit']:
370
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
372
self._emit_progress_update()
377
def _any_real_changes(self):
378
"""Are there real changes between new_inventory and basis?
380
For trees without rich roots, inv.root.revision changes every commit.
381
But if that is the only change, we want to treat it as though there
384
new_entries = self.builder.new_inventory.iter_entries()
385
basis_entries = self.basis_inv.iter_entries()
386
new_path, new_root_ie = new_entries.next()
387
basis_path, basis_root_ie = basis_entries.next()
389
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
390
def ie_equal_no_revision(this, other):
391
return ((this.file_id == other.file_id)
392
and (this.name == other.name)
393
and (this.symlink_target == other.symlink_target)
394
and (this.text_sha1 == other.text_sha1)
395
and (this.text_size == other.text_size)
396
and (this.text_id == other.text_id)
397
and (this.parent_id == other.parent_id)
398
and (this.kind == other.kind)
399
and (this.executable == other.executable)
401
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
404
for new_ie, basis_ie in zip(new_entries, basis_entries):
405
if new_ie != basis_ie:
408
# No actual changes present
411
def _check_pointless(self):
412
if self.allow_pointless:
414
# A merge with no effect on files
415
if len(self.parents) > 1:
417
# work around the fact that a newly-initted tree does differ from its
419
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
420
raise PointlessCommit()
421
# Shortcut, if the number of entries changes, then we obviously have
423
if len(self.builder.new_inventory) != len(self.basis_inv):
425
# If length == 1, then we only have the root entry. Which means
426
# that there is no real difference (only the root could be different)
427
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
429
raise PointlessCommit()
431
def _check_bound_branch(self):
432
"""Check to see if the local branch is bound.
434
If it is bound, then most of the commit will actually be
435
done using the remote branch as the target branch.
436
Only at the end will the local branch be updated.
438
if self.local and not self.branch.get_bound_location():
439
raise errors.LocalRequiresBoundBranch()
442
self.master_branch = self.branch.get_master_branch()
444
if not self.master_branch:
445
# make this branch the reference branch for out of date checks.
446
self.master_branch = self.branch
449
# If the master branch is bound, we must fail
450
master_bound_location = self.master_branch.get_bound_location()
451
if master_bound_location:
452
raise errors.CommitToDoubleBoundBranch(self.branch,
453
self.master_branch, master_bound_location)
455
# TODO: jam 20051230 We could automatically push local
456
# commits to the remote branch if they would fit.
457
# But for now, just require remote to be identical
460
# Make sure the local branch is identical to the master
461
master_info = self.master_branch.last_revision_info()
462
local_info = self.branch.last_revision_info()
463
if local_info != master_info:
464
raise errors.BoundBranchOutOfDate(self.branch,
467
# Now things are ready to change the master branch
469
self.bound_branch = self.branch
470
self.master_branch.lock_write()
471
self.master_locked = True
474
"""Cleanup any open locks, progress bars etc."""
475
cleanups = [self._cleanup_bound_branch,
476
self.basis_tree.unlock,
477
self.work_tree.unlock,
479
found_exception = None
480
for cleanup in cleanups:
483
# we want every cleanup to run no matter what.
484
# so we have a catchall here, but we will raise the
485
# last encountered exception up the stack: and
486
# typically this will be useful enough.
489
if found_exception is not None:
490
# don't do a plan raise, because the last exception may have been
491
# trashed, e is our sure-to-work exception even though it loses the
492
# full traceback. XXX: RBC 20060421 perhaps we could check the
493
# exc_info and if its the same one do a plain raise otherwise
494
# 'raise e' as we do now.
497
def _cleanup_bound_branch(self):
498
"""Executed at the end of a try/finally to cleanup a bound branch.
500
If the branch wasn't bound, this is a no-op.
501
If it was, it resents self.branch to the local branch, instead
504
if not self.bound_branch:
506
if self.master_locked:
507
self.master_branch.unlock()
509
def _escape_commit_message(self):
510
"""Replace xml-incompatible control characters."""
511
# FIXME: RBC 20060419 this should be done by the revision
512
# serialiser not by commit. Then we can also add an unescaper
513
# in the deserializer and start roundtripping revision messages
514
# precisely. See repository_implementations/test_repository.py
516
# Python strings can include characters that can't be
517
# represented in well-formed XML; escape characters that
518
# aren't listed in the XML specification
519
# (http://www.w3.org/TR/REC-xml/#NT-Char).
520
self.message, escape_count = re.subn(
521
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
522
lambda match: match.group(0).encode('unicode_escape'),
525
self.reporter.escaped(escape_count, self.message)
527
def _gather_parents(self):
528
"""Record the parents of a merge for merge detection."""
529
# TODO: Make sure that this list doesn't contain duplicate
530
# entries and the order is preserved when doing this.
531
self.parents = self.work_tree.get_parent_ids()
532
self.parent_invs = [self.basis_inv]
533
for revision in self.parents[1:]:
534
if self.branch.repository.has_revision(revision):
535
mutter('commit parent revision {%s}', revision)
536
inventory = self.branch.repository.get_inventory(revision)
537
self.parent_invs.append(inventory)
539
mutter('commit parent ghost revision {%s}', revision)
541
def _remove_deleted(self):
542
"""Remove deleted files from the working inventories.
544
This is done prior to taking the working inventory as the
545
basis for the new committed inventory.
547
This returns true if any files
548
*that existed in the basis inventory* were deleted.
549
Files that were added and deleted
550
in the working copy don't matter.
552
specific = self.specific_files
554
deleted_paths = set()
555
for path, ie in self.work_inv.iter_entries():
556
if is_inside_any(deleted_paths, path):
557
# The tree will delete the required ids recursively.
559
if specific and not is_inside_any(specific, path):
561
if not self.work_tree.has_filename(path):
562
deleted_paths.add(path)
563
self.reporter.missing(path)
564
deleted_ids.append(ie.file_id)
565
self.work_tree.unversion(deleted_ids)
567
def _populate_new_inv(self):
568
"""Build revision inventory.
570
This creates a new empty inventory. Depending on
571
which files are selected for commit, and what is present in the
572
current tree, the new inventory is populated. inventory entries
573
which are candidates for modification have their revision set to
574
None; inventory entries that are carried over untouched have their
575
revision set to their prior value.
577
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
578
# results to create a new inventory at the same time, which results
579
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
581
mutter("Selecting files for commit with filter %s", self.specific_files)
582
assert self.work_inv.root is not None
583
entries = self.work_inv.iter_entries()
584
if not self.builder.record_root_entry:
585
symbol_versioning.warn('CommitBuilders should support recording'
586
' the root entry as of bzr 0.10.', DeprecationWarning,
588
self.builder.new_inventory.add(self.basis_inv.root.copy())
590
self._emit_progress_update()
591
for path, new_ie in entries:
592
self._emit_progress_update()
593
file_id = new_ie.file_id
595
kind = self.work_tree.kind(file_id)
596
if kind != new_ie.kind:
597
new_ie = inventory.make_entry(kind, new_ie.name,
598
new_ie.parent_id, file_id)
599
except errors.NoSuchFile:
601
# mutter('check %s {%s}', path, file_id)
602
if (not self.specific_files or
603
is_inside_or_parent_of_any(self.specific_files, path)):
604
# mutter('%s selected for commit', path)
608
# mutter('%s not selected for commit', path)
609
if self.basis_inv.has_id(file_id):
610
ie = self.basis_inv[file_id].copy()
612
# this entry is new and not being committed
614
self.builder.record_entry_contents(ie, self.parent_invs,
615
path, self.work_tree)
616
# describe the nature of the change that has occurred relative to
617
# the basis inventory.
618
if (self.basis_inv.has_id(ie.file_id)):
619
basis_ie = self.basis_inv[ie.file_id]
622
change = ie.describe_change(basis_ie, ie)
623
if change in (InventoryEntry.RENAMED,
624
InventoryEntry.MODIFIED_AND_RENAMED):
625
old_path = self.basis_inv.id2path(ie.file_id)
626
self.reporter.renamed(change, old_path, path)
628
self.reporter.snapshot_change(change, path)
630
if not self.specific_files:
633
# ignore removals that don't match filespec
634
for path, new_ie in self.basis_inv.iter_entries():
635
if new_ie.file_id in self.work_inv:
637
if is_inside_any(self.specific_files, path):
641
self.builder.record_entry_contents(ie, self.parent_invs, path,
644
def _emit_progress_update(self):
645
"""Emit an update to the progress bar."""
646
self.pb.update("Committing", self.pb_count, self.pb_total)
649
def _report_deletes(self):
650
for path, ie in self.basis_inv.iter_entries():
651
if ie.file_id not in self.builder.new_inventory:
652
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
