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.errors import (BzrError, PointlessCommit,
68
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
69
is_inside_or_parent_of_any,
70
quotefn, sha_file, split_lines)
71
from bzrlib.testament import Testament
72
from bzrlib.trace import mutter, note, warning
73
from bzrlib.xml5 import serializer_v5
74
from bzrlib.inventory import Inventory, InventoryEntry
75
from bzrlib import symbol_versioning
76
from bzrlib.symbol_versioning import (deprecated_passed,
79
from bzrlib.workingtree import WorkingTree
83
class NullCommitReporter(object):
84
"""I report on progress of a commit."""
86
def snapshot_change(self, change, path):
89
def completed(self, revno, rev_id):
92
def deleted(self, file_id):
95
def escaped(self, escape_count, message):
98
def missing(self, path):
101
def renamed(self, change, old_path, new_path):
105
class ReportCommitToLog(NullCommitReporter):
107
# this may be more useful if 'note' was replaced by an overridable
108
# method on self, which would allow more trivial subclassing.
109
# alternative, a callable could be passed in, allowing really trivial
110
# reuse for some uis. RBC 20060511
112
def snapshot_change(self, change, path):
113
if change == 'unchanged':
115
if change == 'added' and path == '':
117
note("%s %s", change, path)
119
def completed(self, revno, rev_id):
120
note('Committed revision %d.', revno)
122
def deleted(self, file_id):
123
note('deleted %s', file_id)
125
def escaped(self, escape_count, message):
126
note("replaced %d control characters in message", escape_count)
128
def missing(self, path):
129
note('missing %s', path)
131
def renamed(self, change, old_path, new_path):
132
note('%s %s => %s', change, old_path, new_path)
135
class Commit(object):
136
"""Task of committing a new revision.
138
This is a MethodObject: it accumulates state as the commit is
139
prepared, and then it is discarded. It doesn't represent
140
historical revisions, just the act of recording a new one.
143
Modified to hold a list of files that have been deleted from
144
the working directory; these should be removed from the
150
if reporter is not None:
151
self.reporter = reporter
153
self.reporter = NullCommitReporter()
154
if config is not None:
160
branch=DEPRECATED_PARAMETER, message=None,
166
allow_pointless=True,
174
message_callback=None):
175
"""Commit working copy as a new revision.
177
branch -- the deprecated branch to commit to. New callers should pass in
180
message -- the commit message (it or message_callback is required)
182
timestamp -- if not None, seconds-since-epoch for a
183
postdated/predated commit.
185
specific_files -- If true, commit only those files.
187
rev_id -- If set, use this as the new revision id.
188
Useful for test or import commands that need to tightly
189
control what revisions are assigned. If you duplicate
190
a revision id that exists elsewhere it is your own fault.
191
If null (default), a time/random revision id is generated.
193
allow_pointless -- If true (default), commit even if nothing
194
has changed and no merges are recorded.
196
strict -- If true, don't allow a commit if the working tree
197
contains unknown files.
199
revprops -- Properties for new revision
200
:param local: Perform a local only commit.
202
mutter('preparing to commit')
204
if deprecated_passed(branch):
205
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
206
"deprecated as of bzr 0.8. Please use working_tree= instead.",
207
DeprecationWarning, stacklevel=2)
209
self.work_tree = self.branch.bzrdir.open_workingtree()
210
elif working_tree is None:
211
raise BzrError("One of branch and working_tree must be passed into commit().")
213
self.work_tree = working_tree
214
self.branch = self.work_tree.branch
215
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
216
if not self.branch.repository.supports_rich_root():
217
raise errors.RootNotRich()
218
if message_callback is None:
219
if message is not None:
220
if isinstance(message, str):
221
message = message.decode(bzrlib.user_encoding)
222
message_callback = lambda x: message
224
raise BzrError("The message or message_callback keyword"
225
" parameter is required for commit().")
227
self.bound_branch = None
229
self.master_branch = None
230
self.master_locked = False
232
self.specific_files = specific_files
233
self.allow_pointless = allow_pointless
235
if reporter is None and self.reporter is None:
236
self.reporter = NullCommitReporter()
237
elif reporter is not None:
238
self.reporter = reporter
240
self.work_tree.lock_write()
241
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
243
# Cannot commit with conflicts present.
244
if len(self.work_tree.conflicts())>0:
245
raise ConflictsInTree
247
# setup the bound branch variables as needed.
248
self._check_bound_branch()
250
# check for out of date working trees
252
first_tree_parent = self.work_tree.get_parent_ids()[0]
254
# if there are no parents, treat our parent as 'None'
255
# this is so that we still consier the master branch
256
# - in a checkout scenario the tree may have no
257
# parents but the branch may do.
258
first_tree_parent = None
259
master_last = self.master_branch.last_revision()
260
if (master_last is not None and
261
master_last != first_tree_parent):
262
raise errors.OutOfDateTree(self.work_tree)
265
# raise an exception as soon as we find a single unknown.
266
for unknown in self.work_tree.unknowns():
267
raise StrictCommitFailed()
269
if self.config is None:
270
self.config = self.branch.get_config()
272
self.work_inv = self.work_tree.inventory
273
self.basis_tree = self.work_tree.basis_tree()
274
self.basis_inv = self.basis_tree.inventory
275
if specific_files is not None:
276
# Ensure specified files are versioned
277
# (We don't actually need the ids here)
278
tree.find_ids_across_trees(specific_files,
279
[self.basis_tree, self.work_tree])
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
self._check_pointless()
302
self._emit_progress_update()
303
# TODO: Now the new inventory is known, check for conflicts and
304
# prompt the user for a commit message.
305
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
306
# weave lines, because nothing should be recorded until it is known
307
# that commit will succeed.
308
self.builder.finish_inventory()
309
self._emit_progress_update()
310
message = message_callback(self)
311
assert isinstance(message, unicode), type(message)
312
self.message = message
313
self._escape_commit_message()
315
self.rev_id = self.builder.commit(self.message)
316
self._emit_progress_update()
317
# revision data is in the local branch now.
319
# upload revision data to the master.
320
# this will propagate merged revisions too if needed.
321
if self.bound_branch:
322
self.master_branch.repository.fetch(self.branch.repository,
323
revision_id=self.rev_id)
324
# now the master has the revision data
325
# 'commit' to the master first so a timeout here causes the local
326
# branch to be out of date
327
self.master_branch.append_revision(self.rev_id)
329
# and now do the commit locally.
330
self.branch.append_revision(self.rev_id)
332
rev_tree = self.builder.revision_tree()
333
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
334
# now the work tree is up to date with the branch
336
self.reporter.completed(self.branch.revno(), self.rev_id)
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
self._emit_progress_update()
350
def _any_real_changes(self):
351
"""Are there real changes between new_inventory and basis?
353
For trees without rich roots, inv.root.revision changes every commit.
354
But if that is the only change, we want to treat it as though there
357
new_entries = self.builder.new_inventory.iter_entries()
358
basis_entries = self.basis_inv.iter_entries()
359
new_path, new_root_ie = new_entries.next()
360
basis_path, basis_root_ie = basis_entries.next()
362
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
363
def ie_equal_no_revision(this, other):
364
return ((this.file_id == other.file_id)
365
and (this.name == other.name)
366
and (this.symlink_target == other.symlink_target)
367
and (this.text_sha1 == other.text_sha1)
368
and (this.text_size == other.text_size)
369
and (this.text_id == other.text_id)
370
and (this.parent_id == other.parent_id)
371
and (this.kind == other.kind)
372
and (this.executable == other.executable)
374
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
377
for new_ie, basis_ie in zip(new_entries, basis_entries):
378
if new_ie != basis_ie:
381
# No actual changes present
384
def _check_pointless(self):
385
if self.allow_pointless:
387
# A merge with no effect on files
388
if len(self.parents) > 1:
390
# work around the fact that a newly-initted tree does differ from its
392
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
393
raise PointlessCommit()
394
# Shortcut, if the number of entries changes, then we obviously have
396
if len(self.builder.new_inventory) != len(self.basis_inv):
398
# If length == 1, then we only have the root entry. Which means
399
# that there is no real difference (only the root could be different)
400
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
402
raise PointlessCommit()
404
def _check_bound_branch(self):
405
"""Check to see if the local branch is bound.
407
If it is bound, then most of the commit will actually be
408
done using the remote branch as the target branch.
409
Only at the end will the local branch be updated.
411
if self.local and not self.branch.get_bound_location():
412
raise errors.LocalRequiresBoundBranch()
415
self.master_branch = self.branch.get_master_branch()
417
if not self.master_branch:
418
# make this branch the reference branch for out of date checks.
419
self.master_branch = self.branch
422
# If the master branch is bound, we must fail
423
master_bound_location = self.master_branch.get_bound_location()
424
if master_bound_location:
425
raise errors.CommitToDoubleBoundBranch(self.branch,
426
self.master_branch, master_bound_location)
428
# TODO: jam 20051230 We could automatically push local
429
# commits to the remote branch if they would fit.
430
# But for now, just require remote to be identical
433
# Make sure the local branch is identical to the master
434
master_rh = self.master_branch.revision_history()
435
local_rh = self.branch.revision_history()
436
if local_rh != master_rh:
437
raise errors.BoundBranchOutOfDate(self.branch,
440
# Now things are ready to change the master branch
442
self.bound_branch = self.branch
443
self.master_branch.lock_write()
444
self.master_locked = True
447
"""Cleanup any open locks, progress bars etc."""
448
cleanups = [self._cleanup_bound_branch,
449
self.work_tree.unlock,
451
found_exception = None
452
for cleanup in cleanups:
455
# we want every cleanup to run no matter what.
456
# so we have a catchall here, but we will raise the
457
# last encountered exception up the stack: and
458
# typically this will be useful enough.
461
if found_exception is not None:
462
# don't do a plan raise, because the last exception may have been
463
# trashed, e is our sure-to-work exception even though it loses the
464
# full traceback. XXX: RBC 20060421 perhaps we could check the
465
# exc_info and if its the same one do a plain raise otherwise
466
# 'raise e' as we do now.
469
def _cleanup_bound_branch(self):
470
"""Executed at the end of a try/finally to cleanup a bound branch.
472
If the branch wasn't bound, this is a no-op.
473
If it was, it resents self.branch to the local branch, instead
476
if not self.bound_branch:
478
if self.master_locked:
479
self.master_branch.unlock()
481
def _escape_commit_message(self):
482
"""Replace xml-incompatible control characters."""
483
# FIXME: RBC 20060419 this should be done by the revision
484
# serialiser not by commit. Then we can also add an unescaper
485
# in the deserializer and start roundtripping revision messages
486
# precisely. See repository_implementations/test_repository.py
488
# Python strings can include characters that can't be
489
# represented in well-formed XML; escape characters that
490
# aren't listed in the XML specification
491
# (http://www.w3.org/TR/REC-xml/#NT-Char).
492
self.message, escape_count = re.subn(
493
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
494
lambda match: match.group(0).encode('unicode_escape'),
497
self.reporter.escaped(escape_count, self.message)
499
def _gather_parents(self):
500
"""Record the parents of a merge for merge detection."""
501
# TODO: Make sure that this list doesn't contain duplicate
502
# entries and the order is preserved when doing this.
503
self.parents = self.work_tree.get_parent_ids()
504
self.parent_invs = []
505
for revision in self.parents:
506
if self.branch.repository.has_revision(revision):
507
mutter('commit parent revision {%s}', revision)
508
inventory = self.branch.repository.get_inventory(revision)
509
self.parent_invs.append(inventory)
511
mutter('commit parent ghost revision {%s}', revision)
513
def _remove_deleted(self):
514
"""Remove deleted files from the working inventories.
516
This is done prior to taking the working inventory as the
517
basis for the new committed inventory.
519
This returns true if any files
520
*that existed in the basis inventory* were deleted.
521
Files that were added and deleted
522
in the working copy don't matter.
524
specific = self.specific_files
526
deleted_paths = set()
527
for path, ie in self.work_inv.iter_entries():
528
if is_inside_any(deleted_paths, path):
529
# The tree will delete the required ids recursively.
531
if specific and not is_inside_any(specific, path):
533
if not self.work_tree.has_filename(path):
534
deleted_paths.add(path)
535
self.reporter.missing(path)
536
deleted_ids.append(ie.file_id)
537
self.work_tree.unversion(deleted_ids)
539
def _populate_new_inv(self):
540
"""Build revision inventory.
542
This creates a new empty inventory. Depending on
543
which files are selected for commit, and what is present in the
544
current tree, the new inventory is populated. inventory entries
545
which are candidates for modification have their revision set to
546
None; inventory entries that are carried over untouched have their
547
revision set to their prior value.
549
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
550
# results to create a new inventory at the same time, which results
551
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
553
mutter("Selecting files for commit with filter %s", self.specific_files)
554
assert self.work_inv.root is not None
555
entries = self.work_inv.iter_entries()
556
if not self.builder.record_root_entry:
557
symbol_versioning.warn('CommitBuilders should support recording'
558
' the root entry as of bzr 0.10.', DeprecationWarning,
560
self.builder.new_inventory.add(self.basis_inv.root.copy())
562
self._emit_progress_update()
563
for path, new_ie in entries:
564
self._emit_progress_update()
565
file_id = new_ie.file_id
566
# mutter('check %s {%s}', path, file_id)
567
if (not self.specific_files or
568
is_inside_or_parent_of_any(self.specific_files, path)):
569
# mutter('%s selected for commit', path)
573
# mutter('%s not selected for commit', path)
574
if self.basis_inv.has_id(file_id):
575
ie = self.basis_inv[file_id].copy()
577
# this entry is new and not being committed
579
self.builder.record_entry_contents(ie, self.parent_invs,
580
path, self.work_tree)
581
# describe the nature of the change that has occurred relative to
582
# the basis inventory.
583
if (self.basis_inv.has_id(ie.file_id)):
584
basis_ie = self.basis_inv[ie.file_id]
587
change = ie.describe_change(basis_ie, ie)
588
if change in (InventoryEntry.RENAMED,
589
InventoryEntry.MODIFIED_AND_RENAMED):
590
old_path = self.basis_inv.id2path(ie.file_id)
591
self.reporter.renamed(change, old_path, path)
593
self.reporter.snapshot_change(change, path)
595
if not self.specific_files:
598
# ignore removals that don't match filespec
599
for path, new_ie in self.basis_inv.iter_entries():
600
if new_ie.file_id in self.work_inv:
602
if is_inside_any(self.specific_files, path):
606
self.builder.record_entry_contents(ie, self.parent_invs, path,
609
def _emit_progress_update(self):
610
"""Emit an update to the progress bar."""
611
self.pb.update("Committing", self.pb_count, self.pb_total)
614
def _report_deletes(self):
615
for path, ie in self.basis_inv.iter_entries():
616
if ie.file_id not in self.builder.new_inventory:
617
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
