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 message_callback is None:
218
if message is not None:
219
if isinstance(message, str):
220
message = message.decode(bzrlib.user_encoding)
221
message_callback = lambda x: message
223
raise BzrError("The message or message_callback keyword"
224
" parameter is required for commit().")
226
self.bound_branch = None
228
self.master_branch = None
229
self.master_locked = False
231
self.specific_files = specific_files
232
self.allow_pointless = allow_pointless
234
if reporter is None and self.reporter is None:
235
self.reporter = NullCommitReporter()
236
elif reporter is not None:
237
self.reporter = reporter
239
self.work_tree.lock_write()
240
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
242
# Cannot commit with conflicts present.
243
if len(self.work_tree.conflicts())>0:
244
raise ConflictsInTree
246
# setup the bound branch variables as needed.
247
self._check_bound_branch()
249
# check for out of date working trees
251
first_tree_parent = self.work_tree.get_parent_ids()[0]
253
# if there are no parents, treat our parent as 'None'
254
# this is so that we still consier the master branch
255
# - in a checkout scenario the tree may have no
256
# parents but the branch may do.
257
first_tree_parent = bzrlib.revision.NULL_REVISION
258
old_revno, master_last = self.master_branch.last_revision_info()
259
if master_last != first_tree_parent:
260
if master_last != bzrlib.revision.NULL_REVISION:
261
raise errors.OutOfDateTree(self.work_tree)
262
if self.branch.repository.has_revision(first_tree_parent):
263
new_revno = old_revno + 1
265
# ghost parents never appear in revision history.
268
# raise an exception as soon as we find a single unknown.
269
for unknown in self.work_tree.unknowns():
270
raise StrictCommitFailed()
272
if self.config is None:
273
self.config = self.branch.get_config()
275
self.work_inv = self.work_tree.inventory
276
self.basis_tree = self.work_tree.basis_tree()
277
self.basis_inv = self.basis_tree.inventory
278
if specific_files is not None:
279
# Ensure specified files are versioned
280
# (We don't actually need the ids here)
281
tree.find_ids_across_trees(specific_files,
282
[self.basis_tree, self.work_tree])
283
# one to finish, one for rev and inventory, and one for each
284
# inventory entry, and the same for the new inventory.
285
# note that this estimate is too long when we do a partial tree
286
# commit which excludes some new files from being considered.
287
# The estimate is corrected when we populate the new inv.
288
self.pb_total = len(self.work_inv) + 5
291
self._gather_parents()
292
if len(self.parents) > 1 and self.specific_files:
293
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
296
self.builder = self.branch.get_commit_builder(self.parents,
297
self.config, timestamp, timezone, committer, revprops, rev_id)
299
self._remove_deleted()
300
self._populate_new_inv()
301
self._report_deletes()
303
self._check_pointless()
305
self._emit_progress_update()
306
# TODO: Now the new inventory is known, check for conflicts and
307
# prompt the user for a commit message.
308
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
309
# weave lines, because nothing should be recorded until it is known
310
# that commit will succeed.
311
self.builder.finish_inventory()
312
self._emit_progress_update()
313
message = message_callback(self)
314
assert isinstance(message, unicode), type(message)
315
self.message = message
316
self._escape_commit_message()
318
self.rev_id = self.builder.commit(self.message)
319
self._emit_progress_update()
320
# revision data is in the local branch now.
322
# upload revision data to the master.
323
# this will propagate merged revisions too if needed.
324
if self.bound_branch:
325
self.master_branch.repository.fetch(self.branch.repository,
326
revision_id=self.rev_id)
327
# now the master has the revision data
328
# 'commit' to the master first so a timeout here causes the local
329
# branch to be out of date
330
self.master_branch.set_last_revision_info(new_revno,
333
# and now do the commit locally.
334
self.branch.set_last_revision_info(new_revno, self.rev_id)
336
rev_tree = self.builder.revision_tree()
337
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
338
# now the work tree is up to date with the branch
340
self.reporter.completed(new_revno, self.rev_id)
341
# old style commit hooks - should be deprecated ? (obsoleted in
343
if self.config.post_commit() is not None:
344
hooks = self.config.post_commit().split(' ')
345
# this would be nicer with twisted.python.reflect.namedAny
347
result = eval(hook + '(branch, rev_id)',
348
{'branch':self.branch,
350
'rev_id':self.rev_id})
351
# new style commit hooks:
352
if not self.bound_branch:
353
hook_master = self.branch
356
hook_master = self.master_branch
357
hook_local = self.branch
358
# With bound branches, when the master is behind the local branch,
359
# the 'old_revno' and old_revid values here are incorrect.
360
# XXX: FIXME ^. RBC 20060206
362
old_revid = self.parents[0]
364
old_revid = bzrlib.revision.NULL_REVISION
365
for hook in Branch.hooks['post_commit']:
366
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
368
self._emit_progress_update()
373
def _any_real_changes(self):
374
"""Are there real changes between new_inventory and basis?
376
For trees without rich roots, inv.root.revision changes every commit.
377
But if that is the only change, we want to treat it as though there
380
new_entries = self.builder.new_inventory.iter_entries()
381
basis_entries = self.basis_inv.iter_entries()
382
new_path, new_root_ie = new_entries.next()
383
basis_path, basis_root_ie = basis_entries.next()
385
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
386
def ie_equal_no_revision(this, other):
387
return ((this.file_id == other.file_id)
388
and (this.name == other.name)
389
and (this.symlink_target == other.symlink_target)
390
and (this.text_sha1 == other.text_sha1)
391
and (this.text_size == other.text_size)
392
and (this.text_id == other.text_id)
393
and (this.parent_id == other.parent_id)
394
and (this.kind == other.kind)
395
and (this.executable == other.executable)
397
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
400
for new_ie, basis_ie in zip(new_entries, basis_entries):
401
if new_ie != basis_ie:
404
# No actual changes present
407
def _check_pointless(self):
408
if self.allow_pointless:
410
# A merge with no effect on files
411
if len(self.parents) > 1:
413
# work around the fact that a newly-initted tree does differ from its
415
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
416
raise PointlessCommit()
417
# Shortcut, if the number of entries changes, then we obviously have
419
if len(self.builder.new_inventory) != len(self.basis_inv):
421
# If length == 1, then we only have the root entry. Which means
422
# that there is no real difference (only the root could be different)
423
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
425
raise PointlessCommit()
427
def _check_bound_branch(self):
428
"""Check to see if the local branch is bound.
430
If it is bound, then most of the commit will actually be
431
done using the remote branch as the target branch.
432
Only at the end will the local branch be updated.
434
if self.local and not self.branch.get_bound_location():
435
raise errors.LocalRequiresBoundBranch()
438
self.master_branch = self.branch.get_master_branch()
440
if not self.master_branch:
441
# make this branch the reference branch for out of date checks.
442
self.master_branch = self.branch
445
# If the master branch is bound, we must fail
446
master_bound_location = self.master_branch.get_bound_location()
447
if master_bound_location:
448
raise errors.CommitToDoubleBoundBranch(self.branch,
449
self.master_branch, master_bound_location)
451
# TODO: jam 20051230 We could automatically push local
452
# commits to the remote branch if they would fit.
453
# But for now, just require remote to be identical
456
# Make sure the local branch is identical to the master
457
master_info = self.master_branch.last_revision_info()
458
local_info = self.branch.last_revision_info()
459
if local_info != master_info:
460
raise errors.BoundBranchOutOfDate(self.branch,
463
# Now things are ready to change the master branch
465
self.bound_branch = self.branch
466
self.master_branch.lock_write()
467
self.master_locked = True
470
"""Cleanup any open locks, progress bars etc."""
471
cleanups = [self._cleanup_bound_branch,
472
self.work_tree.unlock,
474
found_exception = None
475
for cleanup in cleanups:
478
# we want every cleanup to run no matter what.
479
# so we have a catchall here, but we will raise the
480
# last encountered exception up the stack: and
481
# typically this will be useful enough.
484
if found_exception is not None:
485
# don't do a plan raise, because the last exception may have been
486
# trashed, e is our sure-to-work exception even though it loses the
487
# full traceback. XXX: RBC 20060421 perhaps we could check the
488
# exc_info and if its the same one do a plain raise otherwise
489
# 'raise e' as we do now.
492
def _cleanup_bound_branch(self):
493
"""Executed at the end of a try/finally to cleanup a bound branch.
495
If the branch wasn't bound, this is a no-op.
496
If it was, it resents self.branch to the local branch, instead
499
if not self.bound_branch:
501
if self.master_locked:
502
self.master_branch.unlock()
504
def _escape_commit_message(self):
505
"""Replace xml-incompatible control characters."""
506
# FIXME: RBC 20060419 this should be done by the revision
507
# serialiser not by commit. Then we can also add an unescaper
508
# in the deserializer and start roundtripping revision messages
509
# precisely. See repository_implementations/test_repository.py
511
# Python strings can include characters that can't be
512
# represented in well-formed XML; escape characters that
513
# aren't listed in the XML specification
514
# (http://www.w3.org/TR/REC-xml/#NT-Char).
515
self.message, escape_count = re.subn(
516
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
517
lambda match: match.group(0).encode('unicode_escape'),
520
self.reporter.escaped(escape_count, self.message)
522
def _gather_parents(self):
523
"""Record the parents of a merge for merge detection."""
524
# TODO: Make sure that this list doesn't contain duplicate
525
# entries and the order is preserved when doing this.
526
self.parents = self.work_tree.get_parent_ids()
527
self.parent_invs = [self.basis_inv]
528
for revision in self.parents[1:]:
529
if self.branch.repository.has_revision(revision):
530
mutter('commit parent revision {%s}', revision)
531
inventory = self.branch.repository.get_inventory(revision)
532
self.parent_invs.append(inventory)
534
mutter('commit parent ghost revision {%s}', revision)
536
def _remove_deleted(self):
537
"""Remove deleted files from the working inventories.
539
This is done prior to taking the working inventory as the
540
basis for the new committed inventory.
542
This returns true if any files
543
*that existed in the basis inventory* were deleted.
544
Files that were added and deleted
545
in the working copy don't matter.
547
specific = self.specific_files
549
deleted_paths = set()
550
for path, ie in self.work_inv.iter_entries():
551
if is_inside_any(deleted_paths, path):
552
# The tree will delete the required ids recursively.
554
if specific and not is_inside_any(specific, path):
556
if not self.work_tree.has_filename(path):
557
deleted_paths.add(path)
558
self.reporter.missing(path)
559
deleted_ids.append(ie.file_id)
560
self.work_tree.unversion(deleted_ids)
562
def _populate_new_inv(self):
563
"""Build revision inventory.
565
This creates a new empty inventory. Depending on
566
which files are selected for commit, and what is present in the
567
current tree, the new inventory is populated. inventory entries
568
which are candidates for modification have their revision set to
569
None; inventory entries that are carried over untouched have their
570
revision set to their prior value.
572
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
573
# results to create a new inventory at the same time, which results
574
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
576
mutter("Selecting files for commit with filter %s", self.specific_files)
577
assert self.work_inv.root is not None
578
entries = self.work_inv.iter_entries()
579
if not self.builder.record_root_entry:
580
symbol_versioning.warn('CommitBuilders should support recording'
581
' the root entry as of bzr 0.10.', DeprecationWarning,
583
self.builder.new_inventory.add(self.basis_inv.root.copy())
585
self._emit_progress_update()
586
for path, new_ie in entries:
587
self._emit_progress_update()
588
file_id = new_ie.file_id
590
kind = self.work_tree.kind(file_id)
591
if kind != new_ie.kind:
592
new_ie = inventory.make_entry(kind, new_ie.name,
593
new_ie.parent_id, file_id)
594
except errors.NoSuchFile:
596
# mutter('check %s {%s}', path, file_id)
597
if (not self.specific_files or
598
is_inside_or_parent_of_any(self.specific_files, path)):
599
# mutter('%s selected for commit', path)
603
# mutter('%s not selected for commit', path)
604
if self.basis_inv.has_id(file_id):
605
ie = self.basis_inv[file_id].copy()
607
# this entry is new and not being committed
609
self.builder.record_entry_contents(ie, self.parent_invs,
610
path, self.work_tree)
611
# describe the nature of the change that has occurred relative to
612
# the basis inventory.
613
if (self.basis_inv.has_id(ie.file_id)):
614
basis_ie = self.basis_inv[ie.file_id]
617
change = ie.describe_change(basis_ie, ie)
618
if change in (InventoryEntry.RENAMED,
619
InventoryEntry.MODIFIED_AND_RENAMED):
620
old_path = self.basis_inv.id2path(ie.file_id)
621
self.reporter.renamed(change, old_path, path)
623
self.reporter.snapshot_change(change, path)
625
if not self.specific_files:
628
# ignore removals that don't match filespec
629
for path, new_ie in self.basis_inv.iter_entries():
630
if new_ie.file_id in self.work_inv:
632
if is_inside_any(self.specific_files, path):
636
self.builder.record_entry_contents(ie, self.parent_invs, path,
639
def _emit_progress_update(self):
640
"""Emit an update to the progress bar."""
641
self.pb.update("Committing", self.pb_count, self.pb_total)
644
def _report_deletes(self):
645
for path, ie in self.basis_inv.iter_entries():
646
if ie.file_id not in self.builder.new_inventory:
647
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
