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()
245
# Cannot commit with conflicts present.
246
if len(self.work_tree.conflicts())>0:
247
raise ConflictsInTree
249
# setup the bound branch variables as needed.
250
self._check_bound_branch()
252
# check for out of date working trees
254
first_tree_parent = self.work_tree.get_parent_ids()[0]
256
# if there are no parents, treat our parent as 'None'
257
# this is so that we still consier the master branch
258
# - in a checkout scenario the tree may have no
259
# parents but the branch may do.
260
first_tree_parent = bzrlib.revision.NULL_REVISION
261
old_revno, master_last = self.master_branch.last_revision_info()
262
if master_last != first_tree_parent:
263
if master_last != bzrlib.revision.NULL_REVISION:
264
raise errors.OutOfDateTree(self.work_tree)
265
if self.branch.repository.has_revision(first_tree_parent):
266
new_revno = old_revno + 1
268
# ghost parents never appear in revision history.
271
# raise an exception as soon as we find a single unknown.
272
for unknown in self.work_tree.unknowns():
273
raise StrictCommitFailed()
275
if self.config is None:
276
self.config = self.branch.get_config()
278
self.work_inv = self.work_tree.inventory
279
self.basis_tree = self.work_tree.basis_tree()
280
self.basis_inv = self.basis_tree.inventory
281
if specific_files is not None:
282
# Ensure specified files are versioned
283
# (We don't actually need the ids here)
284
tree.find_ids_across_trees(specific_files,
285
[self.basis_tree, self.work_tree])
286
# one to finish, one for rev and inventory, and one for each
287
# inventory entry, and the same for the new inventory.
288
# note that this estimate is too long when we do a partial tree
289
# commit which excludes some new files from being considered.
290
# The estimate is corrected when we populate the new inv.
291
self.pb_total = len(self.work_inv) + 5
294
self._gather_parents()
295
if len(self.parents) > 1 and self.specific_files:
296
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
299
self.builder = self.branch.get_commit_builder(self.parents,
300
self.config, timestamp, timezone, committer, revprops, rev_id)
302
self._remove_deleted()
303
self._populate_new_inv()
304
self._report_deletes()
306
self._check_pointless()
308
self._emit_progress_update()
309
# TODO: Now the new inventory is known, check for conflicts and
310
# prompt the user for a commit message.
311
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
312
# weave lines, because nothing should be recorded until it is known
313
# that commit will succeed.
314
self.builder.finish_inventory()
315
self._emit_progress_update()
316
message = message_callback(self)
317
assert isinstance(message, unicode), type(message)
318
self.message = message
319
self._escape_commit_message()
321
self.rev_id = self.builder.commit(self.message)
322
self._emit_progress_update()
323
# revision data is in the local branch now.
325
# upload revision data to the master.
326
# this will propagate merged revisions too if needed.
327
if self.bound_branch:
328
self.master_branch.repository.fetch(self.branch.repository,
329
revision_id=self.rev_id)
330
# now the master has the revision data
331
# 'commit' to the master first so a timeout here causes the local
332
# branch to be out of date
333
self.master_branch.set_last_revision_info(new_revno,
336
# and now do the commit locally.
337
self.branch.set_last_revision_info(new_revno, self.rev_id)
339
rev_tree = self.builder.revision_tree()
340
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
341
# now the work tree is up to date with the branch
343
self.reporter.completed(new_revno, self.rev_id)
344
# old style commit hooks - should be deprecated ? (obsoleted in
346
if self.config.post_commit() is not None:
347
hooks = self.config.post_commit().split(' ')
348
# this would be nicer with twisted.python.reflect.namedAny
350
result = eval(hook + '(branch, rev_id)',
351
{'branch':self.branch,
353
'rev_id':self.rev_id})
354
# new style commit hooks:
355
if not self.bound_branch:
356
hook_master = self.branch
359
hook_master = self.master_branch
360
hook_local = self.branch
361
# With bound branches, when the master is behind the local branch,
362
# the 'old_revno' and old_revid values here are incorrect.
363
# XXX: FIXME ^. RBC 20060206
365
old_revid = self.parents[0]
367
old_revid = bzrlib.revision.NULL_REVISION
368
for hook in Branch.hooks['post_commit']:
369
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
371
self._emit_progress_update()
376
def _any_real_changes(self):
377
"""Are there real changes between new_inventory and basis?
379
For trees without rich roots, inv.root.revision changes every commit.
380
But if that is the only change, we want to treat it as though there
383
new_entries = self.builder.new_inventory.iter_entries()
384
basis_entries = self.basis_inv.iter_entries()
385
new_path, new_root_ie = new_entries.next()
386
basis_path, basis_root_ie = basis_entries.next()
388
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
389
def ie_equal_no_revision(this, other):
390
return ((this.file_id == other.file_id)
391
and (this.name == other.name)
392
and (this.symlink_target == other.symlink_target)
393
and (this.text_sha1 == other.text_sha1)
394
and (this.text_size == other.text_size)
395
and (this.text_id == other.text_id)
396
and (this.parent_id == other.parent_id)
397
and (this.kind == other.kind)
398
and (this.executable == other.executable)
400
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
403
for new_ie, basis_ie in zip(new_entries, basis_entries):
404
if new_ie != basis_ie:
407
# No actual changes present
410
def _check_pointless(self):
411
if self.allow_pointless:
413
# A merge with no effect on files
414
if len(self.parents) > 1:
416
# work around the fact that a newly-initted tree does differ from its
418
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
419
raise PointlessCommit()
420
# Shortcut, if the number of entries changes, then we obviously have
422
if len(self.builder.new_inventory) != len(self.basis_inv):
424
# If length == 1, then we only have the root entry. Which means
425
# that there is no real difference (only the root could be different)
426
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
428
raise PointlessCommit()
430
def _check_bound_branch(self):
431
"""Check to see if the local branch is bound.
433
If it is bound, then most of the commit will actually be
434
done using the remote branch as the target branch.
435
Only at the end will the local branch be updated.
437
if self.local and not self.branch.get_bound_location():
438
raise errors.LocalRequiresBoundBranch()
441
self.master_branch = self.branch.get_master_branch()
443
if not self.master_branch:
444
# make this branch the reference branch for out of date checks.
445
self.master_branch = self.branch
448
# If the master branch is bound, we must fail
449
master_bound_location = self.master_branch.get_bound_location()
450
if master_bound_location:
451
raise errors.CommitToDoubleBoundBranch(self.branch,
452
self.master_branch, master_bound_location)
454
# TODO: jam 20051230 We could automatically push local
455
# commits to the remote branch if they would fit.
456
# But for now, just require remote to be identical
459
# Make sure the local branch is identical to the master
460
master_info = self.master_branch.last_revision_info()
461
local_info = self.branch.last_revision_info()
462
if local_info != master_info:
463
raise errors.BoundBranchOutOfDate(self.branch,
466
# Now things are ready to change the master branch
468
self.bound_branch = self.branch
469
self.master_branch.lock_write()
470
self.master_locked = True
473
"""Cleanup any open locks, progress bars etc."""
474
cleanups = [self._cleanup_bound_branch,
475
self.work_tree.unlock,
477
found_exception = None
478
for cleanup in cleanups:
481
# we want every cleanup to run no matter what.
482
# so we have a catchall here, but we will raise the
483
# last encountered exception up the stack: and
484
# typically this will be useful enough.
487
if found_exception is not None:
488
# don't do a plan raise, because the last exception may have been
489
# trashed, e is our sure-to-work exception even though it loses the
490
# full traceback. XXX: RBC 20060421 perhaps we could check the
491
# exc_info and if its the same one do a plain raise otherwise
492
# 'raise e' as we do now.
495
def _cleanup_bound_branch(self):
496
"""Executed at the end of a try/finally to cleanup a bound branch.
498
If the branch wasn't bound, this is a no-op.
499
If it was, it resents self.branch to the local branch, instead
502
if not self.bound_branch:
504
if self.master_locked:
505
self.master_branch.unlock()
507
def _escape_commit_message(self):
508
"""Replace xml-incompatible control characters."""
509
# FIXME: RBC 20060419 this should be done by the revision
510
# serialiser not by commit. Then we can also add an unescaper
511
# in the deserializer and start roundtripping revision messages
512
# precisely. See repository_implementations/test_repository.py
514
# Python strings can include characters that can't be
515
# represented in well-formed XML; escape characters that
516
# aren't listed in the XML specification
517
# (http://www.w3.org/TR/REC-xml/#NT-Char).
518
self.message, escape_count = re.subn(
519
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
520
lambda match: match.group(0).encode('unicode_escape'),
523
self.reporter.escaped(escape_count, self.message)
525
def _gather_parents(self):
526
"""Record the parents of a merge for merge detection."""
527
# TODO: Make sure that this list doesn't contain duplicate
528
# entries and the order is preserved when doing this.
529
self.parents = self.work_tree.get_parent_ids()
530
self.parent_invs = [self.basis_inv]
531
for revision in self.parents[1:]:
532
if self.branch.repository.has_revision(revision):
533
mutter('commit parent revision {%s}', revision)
534
inventory = self.branch.repository.get_inventory(revision)
535
self.parent_invs.append(inventory)
537
mutter('commit parent ghost revision {%s}', revision)
539
def _remove_deleted(self):
540
"""Remove deleted files from the working inventories.
542
This is done prior to taking the working inventory as the
543
basis for the new committed inventory.
545
This returns true if any files
546
*that existed in the basis inventory* were deleted.
547
Files that were added and deleted
548
in the working copy don't matter.
550
specific = self.specific_files
552
deleted_paths = set()
553
for path, ie in self.work_inv.iter_entries():
554
if is_inside_any(deleted_paths, path):
555
# The tree will delete the required ids recursively.
557
if specific and not is_inside_any(specific, path):
559
if not self.work_tree.has_filename(path):
560
deleted_paths.add(path)
561
self.reporter.missing(path)
562
deleted_ids.append(ie.file_id)
563
self.work_tree.unversion(deleted_ids)
565
def _populate_new_inv(self):
566
"""Build revision inventory.
568
This creates a new empty inventory. Depending on
569
which files are selected for commit, and what is present in the
570
current tree, the new inventory is populated. inventory entries
571
which are candidates for modification have their revision set to
572
None; inventory entries that are carried over untouched have their
573
revision set to their prior value.
575
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
576
# results to create a new inventory at the same time, which results
577
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
579
mutter("Selecting files for commit with filter %s", self.specific_files)
580
assert self.work_inv.root is not None
581
entries = self.work_inv.iter_entries()
582
if not self.builder.record_root_entry:
583
symbol_versioning.warn('CommitBuilders should support recording'
584
' the root entry as of bzr 0.10.', DeprecationWarning,
586
self.builder.new_inventory.add(self.basis_inv.root.copy())
588
self._emit_progress_update()
589
for path, new_ie in entries:
590
self._emit_progress_update()
591
file_id = new_ie.file_id
593
kind = self.work_tree.kind(file_id)
594
if kind != new_ie.kind:
595
new_ie = inventory.make_entry(kind, new_ie.name,
596
new_ie.parent_id, file_id)
597
except errors.NoSuchFile:
599
# mutter('check %s {%s}', path, file_id)
600
if (not self.specific_files or
601
is_inside_or_parent_of_any(self.specific_files, path)):
602
# mutter('%s selected for commit', path)
606
# mutter('%s not selected for commit', path)
607
if self.basis_inv.has_id(file_id):
608
ie = self.basis_inv[file_id].copy()
610
# this entry is new and not being committed
612
self.builder.record_entry_contents(ie, self.parent_invs,
613
path, self.work_tree)
614
# describe the nature of the change that has occurred relative to
615
# the basis inventory.
616
if (self.basis_inv.has_id(ie.file_id)):
617
basis_ie = self.basis_inv[ie.file_id]
620
change = ie.describe_change(basis_ie, ie)
621
if change in (InventoryEntry.RENAMED,
622
InventoryEntry.MODIFIED_AND_RENAMED):
623
old_path = self.basis_inv.id2path(ie.file_id)
624
self.reporter.renamed(change, old_path, path)
626
self.reporter.snapshot_change(change, path)
628
if not self.specific_files:
631
# ignore removals that don't match filespec
632
for path, new_ie in self.basis_inv.iter_entries():
633
if new_ie.file_id in self.work_inv:
635
if is_inside_any(self.specific_files, path):
639
self.builder.record_entry_contents(ie, self.parent_invs, path,
642
def _emit_progress_update(self):
643
"""Emit an update to the progress bar."""
644
self.pb.update("Committing", self.pb_count, self.pb_total)
647
def _report_deletes(self):
648
for path, ie in self.basis_inv.iter_entries():
649
if ie.file_id not in self.builder.new_inventory:
650
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
