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
82
class NullCommitReporter(object):
83
"""I report on progress of a commit."""
85
def snapshot_change(self, change, path):
88
def completed(self, revno, rev_id):
91
def deleted(self, file_id):
94
def escaped(self, escape_count, message):
97
def missing(self, path):
100
def renamed(self, change, old_path, new_path):
104
class ReportCommitToLog(NullCommitReporter):
106
# this may be more useful if 'note' was replaced by an overridable
107
# method on self, which would allow more trivial subclassing.
108
# alternative, a callable could be passed in, allowing really trivial
109
# reuse for some uis. RBC 20060511
111
def snapshot_change(self, change, path):
112
if change == 'unchanged':
114
if change == 'added' and path == '':
116
note("%s %s", change, path)
118
def completed(self, revno, rev_id):
119
note('Committed revision %d.', revno)
121
def deleted(self, file_id):
122
note('deleted %s', file_id)
124
def escaped(self, escape_count, message):
125
note("replaced %d control characters in message", escape_count)
127
def missing(self, path):
128
note('missing %s', path)
130
def renamed(self, change, old_path, new_path):
131
note('%s %s => %s', change, old_path, new_path)
134
class Commit(object):
135
"""Task of committing a new revision.
137
This is a MethodObject: it accumulates state as the commit is
138
prepared, and then it is discarded. It doesn't represent
139
historical revisions, just the act of recording a new one.
142
Modified to hold a list of files that have been deleted from
143
the working directory; these should be removed from the
149
if reporter is not None:
150
self.reporter = reporter
152
self.reporter = NullCommitReporter()
153
if config is not None:
159
branch=DEPRECATED_PARAMETER, message=None,
165
allow_pointless=True,
173
message_callback=None):
174
"""Commit working copy as a new revision.
176
branch -- the deprecated branch to commit to. New callers should pass in
179
message -- the commit message (it or message_callback is required)
181
timestamp -- if not None, seconds-since-epoch for a
182
postdated/predated commit.
184
specific_files -- If true, commit only those files.
186
rev_id -- If set, use this as the new revision id.
187
Useful for test or import commands that need to tightly
188
control what revisions are assigned. If you duplicate
189
a revision id that exists elsewhere it is your own fault.
190
If null (default), a time/random revision id is generated.
192
allow_pointless -- If true (default), commit even if nothing
193
has changed and no merges are recorded.
195
strict -- If true, don't allow a commit if the working tree
196
contains unknown files.
198
revprops -- Properties for new revision
199
:param local: Perform a local only commit.
201
mutter('preparing to commit')
203
if deprecated_passed(branch):
204
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
205
"deprecated as of bzr 0.8. Please use working_tree= instead.",
206
DeprecationWarning, stacklevel=2)
208
self.work_tree = self.branch.bzrdir.open_workingtree()
209
elif working_tree is None:
210
raise BzrError("One of branch and working_tree must be passed into commit().")
212
self.work_tree = working_tree
213
self.branch = self.work_tree.branch
214
if message_callback is None:
215
if message is not None:
216
if isinstance(message, str):
217
message = message.decode(bzrlib.user_encoding)
218
message_callback = lambda x: message
220
raise BzrError("The message or message_callback keyword"
221
" parameter is required for commit().")
223
self.bound_branch = None
225
self.master_branch = None
226
self.master_locked = False
228
self.specific_files = specific_files
229
self.allow_pointless = allow_pointless
231
if reporter is None and self.reporter is None:
232
self.reporter = NullCommitReporter()
233
elif reporter is not None:
234
self.reporter = reporter
236
self.work_tree.lock_write()
237
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
239
# Cannot commit with conflicts present.
240
if len(self.work_tree.conflicts())>0:
241
raise ConflictsInTree
243
# setup the bound branch variables as needed.
244
self._check_bound_branch()
246
# check for out of date working trees
248
first_tree_parent = self.work_tree.get_parent_ids()[0]
250
# if there are no parents, treat our parent as 'None'
251
# this is so that we still consier the master branch
252
# - in a checkout scenario the tree may have no
253
# parents but the branch may do.
254
first_tree_parent = None
255
master_last = self.master_branch.last_revision()
256
if (master_last is not None and
257
master_last != first_tree_parent):
258
raise errors.OutOfDateTree(self.work_tree)
261
# raise an exception as soon as we find a single unknown.
262
for unknown in self.work_tree.unknowns():
263
raise StrictCommitFailed()
265
if self.config is None:
266
self.config = self.branch.get_config()
268
self.work_inv = self.work_tree.inventory
269
self.basis_tree = self.work_tree.basis_tree()
270
self.basis_inv = self.basis_tree.inventory
271
if specific_files is not None:
272
# Ensure specified files are versioned
273
# (We don't actually need the ids here)
274
tree.find_ids_across_trees(specific_files,
275
[self.basis_tree, self.work_tree])
276
# one to finish, one for rev and inventory, and one for each
277
# inventory entry, and the same for the new inventory.
278
# note that this estimate is too long when we do a partial tree
279
# commit which excludes some new files from being considered.
280
# The estimate is corrected when we populate the new inv.
281
self.pb_total = len(self.work_inv) + 5
284
self._gather_parents()
285
if len(self.parents) > 1 and self.specific_files:
286
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
289
self.builder = self.branch.get_commit_builder(self.parents,
290
self.config, timestamp, timezone, committer, revprops, rev_id)
292
self._remove_deleted()
293
self._populate_new_inv()
294
self._report_deletes()
296
self._check_pointless()
298
self._emit_progress_update()
299
# TODO: Now the new inventory is known, check for conflicts and
300
# prompt the user for a commit message.
301
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
302
# weave lines, because nothing should be recorded until it is known
303
# that commit will succeed.
304
self.builder.finish_inventory()
305
self._emit_progress_update()
306
message = message_callback(self)
307
assert isinstance(message, unicode), type(message)
308
self.message = message
309
self._escape_commit_message()
311
self.rev_id = self.builder.commit(self.message)
312
self._emit_progress_update()
313
# revision data is in the local branch now.
315
# upload revision data to the master.
316
# this will propagate merged revisions too if needed.
317
if self.bound_branch:
318
self.master_branch.repository.fetch(self.branch.repository,
319
revision_id=self.rev_id)
320
# now the master has the revision data
321
# 'commit' to the master first so a timeout here causes the local
322
# branch to be out of date
323
self.master_branch.append_revision(self.rev_id)
325
# and now do the commit locally.
326
self.branch.append_revision(self.rev_id)
328
rev_tree = self.builder.revision_tree()
329
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
330
# now the work tree is up to date with the branch
332
self.reporter.completed(self.branch.revno(), self.rev_id)
333
if self.config.post_commit() is not None:
334
hooks = self.config.post_commit().split(' ')
335
# this would be nicer with twisted.python.reflect.namedAny
337
result = eval(hook + '(branch, rev_id)',
338
{'branch':self.branch,
340
'rev_id':self.rev_id})
341
self._emit_progress_update()
346
def _any_real_changes(self):
347
"""Are there real changes between new_inventory and basis?
349
For trees without rich roots, inv.root.revision changes every commit.
350
But if that is the only change, we want to treat it as though there
353
new_entries = self.builder.new_inventory.iter_entries()
354
basis_entries = self.basis_inv.iter_entries()
355
new_path, new_root_ie = new_entries.next()
356
basis_path, basis_root_ie = basis_entries.next()
358
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
359
def ie_equal_no_revision(this, other):
360
return ((this.file_id == other.file_id)
361
and (this.name == other.name)
362
and (this.symlink_target == other.symlink_target)
363
and (this.text_sha1 == other.text_sha1)
364
and (this.text_size == other.text_size)
365
and (this.text_id == other.text_id)
366
and (this.parent_id == other.parent_id)
367
and (this.kind == other.kind)
368
and (this.executable == other.executable)
370
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
373
for new_ie, basis_ie in zip(new_entries, basis_entries):
374
if new_ie != basis_ie:
377
# No actual changes present
380
def _check_pointless(self):
381
if self.allow_pointless:
383
# A merge with no effect on files
384
if len(self.parents) > 1:
386
# work around the fact that a newly-initted tree does differ from its
388
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
389
raise PointlessCommit()
390
# Shortcut, if the number of entries changes, then we obviously have
392
if len(self.builder.new_inventory) != len(self.basis_inv):
394
# If length == 1, then we only have the root entry. Which means
395
# that there is no real difference (only the root could be different)
396
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
398
raise PointlessCommit()
400
def _check_bound_branch(self):
401
"""Check to see if the local branch is bound.
403
If it is bound, then most of the commit will actually be
404
done using the remote branch as the target branch.
405
Only at the end will the local branch be updated.
407
if self.local and not self.branch.get_bound_location():
408
raise errors.LocalRequiresBoundBranch()
411
self.master_branch = self.branch.get_master_branch()
413
if not self.master_branch:
414
# make this branch the reference branch for out of date checks.
415
self.master_branch = self.branch
418
# If the master branch is bound, we must fail
419
master_bound_location = self.master_branch.get_bound_location()
420
if master_bound_location:
421
raise errors.CommitToDoubleBoundBranch(self.branch,
422
self.master_branch, master_bound_location)
424
# TODO: jam 20051230 We could automatically push local
425
# commits to the remote branch if they would fit.
426
# But for now, just require remote to be identical
429
# Make sure the local branch is identical to the master
430
master_rh = self.master_branch.revision_history()
431
local_rh = self.branch.revision_history()
432
if local_rh != master_rh:
433
raise errors.BoundBranchOutOfDate(self.branch,
436
# Now things are ready to change the master branch
438
self.bound_branch = self.branch
439
self.master_branch.lock_write()
440
self.master_locked = True
443
"""Cleanup any open locks, progress bars etc."""
444
cleanups = [self._cleanup_bound_branch,
445
self.work_tree.unlock,
447
found_exception = None
448
for cleanup in cleanups:
451
# we want every cleanup to run no matter what.
452
# so we have a catchall here, but we will raise the
453
# last encountered exception up the stack: and
454
# typically this will be useful enough.
457
if found_exception is not None:
458
# don't do a plan raise, because the last exception may have been
459
# trashed, e is our sure-to-work exception even though it loses the
460
# full traceback. XXX: RBC 20060421 perhaps we could check the
461
# exc_info and if its the same one do a plain raise otherwise
462
# 'raise e' as we do now.
465
def _cleanup_bound_branch(self):
466
"""Executed at the end of a try/finally to cleanup a bound branch.
468
If the branch wasn't bound, this is a no-op.
469
If it was, it resents self.branch to the local branch, instead
472
if not self.bound_branch:
474
if self.master_locked:
475
self.master_branch.unlock()
477
def _escape_commit_message(self):
478
"""Replace xml-incompatible control characters."""
479
# FIXME: RBC 20060419 this should be done by the revision
480
# serialiser not by commit. Then we can also add an unescaper
481
# in the deserializer and start roundtripping revision messages
482
# precisely. See repository_implementations/test_repository.py
484
# Python strings can include characters that can't be
485
# represented in well-formed XML; escape characters that
486
# aren't listed in the XML specification
487
# (http://www.w3.org/TR/REC-xml/#NT-Char).
488
self.message, escape_count = re.subn(
489
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
490
lambda match: match.group(0).encode('unicode_escape'),
493
self.reporter.escaped(escape_count, self.message)
495
def _gather_parents(self):
496
"""Record the parents of a merge for merge detection."""
497
# TODO: Make sure that this list doesn't contain duplicate
498
# entries and the order is preserved when doing this.
499
self.parents = self.work_tree.get_parent_ids()
500
self.parent_invs = []
501
for revision in self.parents:
502
if self.branch.repository.has_revision(revision):
503
mutter('commit parent revision {%s}', revision)
504
inventory = self.branch.repository.get_inventory(revision)
505
self.parent_invs.append(inventory)
507
mutter('commit parent ghost revision {%s}', revision)
509
def _remove_deleted(self):
510
"""Remove deleted files from the working inventories.
512
This is done prior to taking the working inventory as the
513
basis for the new committed inventory.
515
This returns true if any files
516
*that existed in the basis inventory* were deleted.
517
Files that were added and deleted
518
in the working copy don't matter.
520
specific = self.specific_files
522
deleted_paths = set()
523
for path, ie in self.work_inv.iter_entries():
524
if is_inside_any(deleted_paths, path):
525
# The tree will delete the required ids recursively.
527
if specific and not is_inside_any(specific, path):
529
if not self.work_tree.has_filename(path):
530
deleted_paths.add(path)
531
self.reporter.missing(path)
532
deleted_ids.append(ie.file_id)
533
self.work_tree.unversion(deleted_ids)
535
def _populate_new_inv(self):
536
"""Build revision inventory.
538
This creates a new empty inventory. Depending on
539
which files are selected for commit, and what is present in the
540
current tree, the new inventory is populated. inventory entries
541
which are candidates for modification have their revision set to
542
None; inventory entries that are carried over untouched have their
543
revision set to their prior value.
545
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
546
# results to create a new inventory at the same time, which results
547
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
549
mutter("Selecting files for commit with filter %s", self.specific_files)
550
assert self.work_inv.root is not None
551
entries = self.work_inv.iter_entries()
552
if not self.builder.record_root_entry:
553
symbol_versioning.warn('CommitBuilders should support recording'
554
' the root entry as of bzr 0.10.', DeprecationWarning,
556
self.builder.new_inventory.add(self.basis_inv.root.copy())
558
self._emit_progress_update()
559
for path, new_ie in entries:
560
self._emit_progress_update()
561
file_id = new_ie.file_id
562
# mutter('check %s {%s}', path, file_id)
563
if (not self.specific_files or
564
is_inside_or_parent_of_any(self.specific_files, path)):
565
# mutter('%s selected for commit', path)
569
# mutter('%s not selected for commit', path)
570
if self.basis_inv.has_id(file_id):
571
ie = self.basis_inv[file_id].copy()
573
# this entry is new and not being committed
575
self.builder.record_entry_contents(ie, self.parent_invs,
576
path, self.work_tree)
577
# describe the nature of the change that has occurred relative to
578
# the basis inventory.
579
if (self.basis_inv.has_id(ie.file_id)):
580
basis_ie = self.basis_inv[ie.file_id]
583
change = ie.describe_change(basis_ie, ie)
584
if change in (InventoryEntry.RENAMED,
585
InventoryEntry.MODIFIED_AND_RENAMED):
586
old_path = self.basis_inv.id2path(ie.file_id)
587
self.reporter.renamed(change, old_path, path)
589
self.reporter.snapshot_change(change, path)
591
if not self.specific_files:
594
# ignore removals that don't match filespec
595
for path, new_ie in self.basis_inv.iter_entries():
596
if new_ie.file_id in self.work_inv:
598
if is_inside_any(self.specific_files, path):
602
self.builder.record_entry_contents(ie, self.parent_invs, path,
605
def _emit_progress_update(self):
606
"""Emit an update to the progress bar."""
607
self.pb.update("Committing", self.pb_count, self.pb_total)
610
def _report_deletes(self):
611
for path, ie in self.basis_inv.iter_entries():
612
if ie.file_id not in self.builder.new_inventory:
613
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
