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