56
46
# merges from, then it should still be reported as newly added
57
47
# relative to the basis revision.
59
# TODO: Do checks that the tree can be committed *before* running the
60
# editor; this should include checks for a pointless commit and for
61
# unknown or missing files.
63
# TODO: If commit fails, leave the message in a file somewhere.
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.
72
from binascii import hexlify
73
57
from cStringIO import StringIO
75
from bzrlib.osutils import (local_time_offset,
76
rand_bytes, compact_date,
77
kind_marker, is_inside_any, quotefn,
78
sha_string, sha_strings, sha_file, isdir, isfile,
80
from bzrlib.branch import gen_file_id
64
from bzrlib.branch import Branch
81
65
import bzrlib.config
82
66
from bzrlib.errors import (BzrError, PointlessCommit,
87
import bzrlib.gpg as gpg
88
from bzrlib.revision import Revision
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)
89
73
from bzrlib.testament import Testament
90
74
from bzrlib.trace import mutter, note, warning
91
75
from bzrlib.xml5 import serializer_v5
92
from bzrlib.inventory import Inventory, ROOT_ID
93
from bzrlib.weave import Weave
94
from bzrlib.weavefile import read_weave, write_weave_v5
95
from bzrlib.atomicfile import AtomicFile
98
def commit(*args, **kwargs):
99
"""Commit a new revision to a branch.
101
Function-style interface for convenience of old callers.
103
New code should use the Commit class instead.
105
## XXX: Remove this in favor of Branch.commit?
106
Commit().commit(*args, **kwargs)
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
109
85
class NullCommitReporter(object):
196
197
contains unknown files.
198
199
revprops -- Properties for new revision
200
:param local: Perform a local only commit.
201
:param recursive: If set to 'down', commit in any subtrees that have
202
pending changes of any sort during this commit.
200
204
mutter('preparing to commit')
203
self.weave_store = branch.weave_store
206
if working_tree is None:
207
raise BzrError("working_tree must be passed into commit().")
209
self.work_tree = working_tree
210
self.branch = self.work_tree.branch
211
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
212
if not self.branch.repository.supports_rich_root():
213
raise errors.RootNotRich()
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
205
228
self.specific_files = specific_files
206
229
self.allow_pointless = allow_pointless
207
self.revprops = {'branch-nick': branch.nick}
209
self.revprops.update(revprops)
212
# raise an exception as soon as we find a single unknown.
213
for unknown in branch.unknowns():
214
raise StrictCommitFailed()
216
if timestamp is None:
217
self.timestamp = time.time()
219
self.timestamp = long(timestamp)
221
if self.config is None:
222
self.config = bzrlib.config.BranchConfig(self.branch)
225
self.rev_id = _gen_revision_id(self.config, self.timestamp)
229
if committer is None:
230
self.committer = self.config.username()
232
assert isinstance(committer, basestring), type(committer)
233
self.committer = committer
236
self.timezone = local_time_offset()
238
self.timezone = int(timezone)
240
if isinstance(message, str):
241
message = message.decode(bzrlib.user_encoding)
242
assert isinstance(message, unicode), type(message)
243
self.message = message
244
self._escape_commit_message()
246
self.branch.lock_write()
230
self.recursive = recursive
231
self.revprops = revprops
232
self.message_callback = message_callback
233
self.timestamp = timestamp
234
self.timezone = timezone
235
self.committer = committer
236
self.specific_files = specific_files
238
self.verbose = verbose
241
if reporter is None and self.reporter is None:
242
self.reporter = NullCommitReporter()
243
elif reporter is not None:
244
self.reporter = reporter
246
self.work_tree.lock_write()
247
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
248
self.basis_tree = self.work_tree.basis_tree()
249
self.basis_tree.lock_read()
248
self.work_tree = self.branch.working_tree()
251
# Cannot commit with conflicts present.
252
if len(self.work_tree.conflicts())>0:
253
raise ConflictsInTree
255
# setup the bound branch variables as needed.
256
self._check_bound_branch()
258
# check for out of date working trees
260
first_tree_parent = self.work_tree.get_parent_ids()[0]
262
# if there are no parents, treat our parent as 'None'
263
# this is so that we still consier the master branch
264
# - in a checkout scenario the tree may have no
265
# parents but the branch may do.
266
first_tree_parent = bzrlib.revision.NULL_REVISION
267
old_revno, master_last = self.master_branch.last_revision_info()
268
if master_last != first_tree_parent:
269
if master_last != bzrlib.revision.NULL_REVISION:
270
raise errors.OutOfDateTree(self.work_tree)
271
if self.branch.repository.has_revision(first_tree_parent):
272
new_revno = old_revno + 1
274
# ghost parents never appear in revision history.
277
# raise an exception as soon as we find a single unknown.
278
for unknown in self.work_tree.unknowns():
279
raise StrictCommitFailed()
281
if self.config is None:
282
self.config = self.branch.get_config()
249
284
self.work_inv = self.work_tree.inventory
250
self.basis_tree = self.branch.basis_tree()
251
285
self.basis_inv = self.basis_tree.inventory
286
if specific_files is not None:
287
# Ensure specified files are versioned
288
# (We don't actually need the ids here)
289
# XXX: Dont we have filter_unversioned to do this more
291
tree.find_ids_across_trees(specific_files,
292
[self.basis_tree, self.work_tree])
293
# one to finish, one for rev and inventory, and one for each
294
# inventory entry, and the same for the new inventory.
295
# note that this estimate is too long when we do a partial tree
296
# commit which excludes some new files from being considered.
297
# The estimate is corrected when we populate the new inv.
298
self.pb_total = len(self.work_inv) + 5
253
301
self._gather_parents()
254
302
if len(self.parents) > 1 and self.specific_files:
255
raise NotImplementedError('selected-file commit of merges is not supported yet')
256
self._check_parents_present()
303
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
306
self.builder = self.branch.get_commit_builder(self.parents,
307
self.config, timestamp, timezone, committer, revprops, rev_id)
258
309
self._remove_deleted()
259
310
self._populate_new_inv()
260
self._store_snapshot()
261
311
self._report_deletes()
263
if not (self.allow_pointless
264
or len(self.parents) > 1
265
or self.new_inv != self.basis_inv):
266
raise PointlessCommit()
268
if len(list(self.work_tree.iter_conflicts()))>0:
269
raise ConflictsInTree
271
self._record_inventory()
272
self._make_revision()
273
self.branch.append_revision(self.rev_id)
274
self.work_tree.set_pending_merges([])
275
self.reporter.completed(self.branch.revno()+1, self.rev_id)
313
self._check_pointless()
315
self._emit_progress_update()
316
# TODO: Now the new inventory is known, check for conflicts and
317
# prompt the user for a commit message.
318
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
319
# weave lines, because nothing should be recorded until it is known
320
# that commit will succeed.
321
self.builder.finish_inventory()
322
self._emit_progress_update()
323
message = message_callback(self)
324
assert isinstance(message, unicode), type(message)
325
self.message = message
326
self._escape_commit_message()
328
self.rev_id = self.builder.commit(self.message)
329
self._emit_progress_update()
330
# revision data is in the local branch now.
332
# upload revision data to the master.
333
# this will propagate merged revisions too if needed.
334
if self.bound_branch:
335
self.master_branch.repository.fetch(self.branch.repository,
336
revision_id=self.rev_id)
337
# now the master has the revision data
338
# 'commit' to the master first so a timeout here causes the local
339
# branch to be out of date
340
self.master_branch.set_last_revision_info(new_revno,
343
# and now do the commit locally.
344
self.branch.set_last_revision_info(new_revno, self.rev_id)
346
rev_tree = self.builder.revision_tree()
347
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
348
# now the work tree is up to date with the branch
350
self.reporter.completed(new_revno, self.rev_id)
351
# old style commit hooks - should be deprecated ? (obsoleted in
276
353
if self.config.post_commit() is not None:
277
354
hooks = self.config.post_commit().split(' ')
278
355
# this would be nicer with twisted.python.reflect.namedAny
281
358
{'branch':self.branch,
283
360
'rev_id':self.rev_id})
361
# new style commit hooks:
362
if not self.bound_branch:
363
hook_master = self.branch
366
hook_master = self.master_branch
367
hook_local = self.branch
368
# With bound branches, when the master is behind the local branch,
369
# the 'old_revno' and old_revid values here are incorrect.
370
# XXX: FIXME ^. RBC 20060206
372
old_revid = self.parents[0]
374
old_revid = bzrlib.revision.NULL_REVISION
375
for hook in Branch.hooks['post_commit']:
376
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
378
self._emit_progress_update()
287
def _record_inventory(self):
288
"""Store the inventory for the new revision."""
289
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
290
self.inv_sha1 = sha_string(inv_text)
291
s = self.branch.control_weaves
292
s.add_text('inventory', self.rev_id,
293
split_lines(inv_text), self.present_parents,
294
self.branch.get_transaction())
383
def _any_real_changes(self):
384
"""Are there real changes between new_inventory and basis?
386
For trees without rich roots, inv.root.revision changes every commit.
387
But if that is the only change, we want to treat it as though there
390
new_entries = self.builder.new_inventory.iter_entries()
391
basis_entries = self.basis_inv.iter_entries()
392
new_path, new_root_ie = new_entries.next()
393
basis_path, basis_root_ie = basis_entries.next()
395
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
396
def ie_equal_no_revision(this, other):
397
return ((this.file_id == other.file_id)
398
and (this.name == other.name)
399
and (this.symlink_target == other.symlink_target)
400
and (this.text_sha1 == other.text_sha1)
401
and (this.text_size == other.text_size)
402
and (this.text_id == other.text_id)
403
and (this.parent_id == other.parent_id)
404
and (this.kind == other.kind)
405
and (this.executable == other.executable)
406
and (this.reference_revision == other.reference_revision)
408
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
411
for new_ie, basis_ie in zip(new_entries, basis_entries):
412
if new_ie != basis_ie:
415
# No actual changes present
418
def _check_pointless(self):
419
if self.allow_pointless:
421
# A merge with no effect on files
422
if len(self.parents) > 1:
424
# work around the fact that a newly-initted tree does differ from its
426
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
427
raise PointlessCommit()
428
# Shortcut, if the number of entries changes, then we obviously have
430
if len(self.builder.new_inventory) != len(self.basis_inv):
432
# If length == 1, then we only have the root entry. Which means
433
# that there is no real difference (only the root could be different)
434
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
436
raise PointlessCommit()
438
def _check_bound_branch(self):
439
"""Check to see if the local branch is bound.
441
If it is bound, then most of the commit will actually be
442
done using the remote branch as the target branch.
443
Only at the end will the local branch be updated.
445
if self.local and not self.branch.get_bound_location():
446
raise errors.LocalRequiresBoundBranch()
449
self.master_branch = self.branch.get_master_branch()
451
if not self.master_branch:
452
# make this branch the reference branch for out of date checks.
453
self.master_branch = self.branch
456
# If the master branch is bound, we must fail
457
master_bound_location = self.master_branch.get_bound_location()
458
if master_bound_location:
459
raise errors.CommitToDoubleBoundBranch(self.branch,
460
self.master_branch, master_bound_location)
462
# TODO: jam 20051230 We could automatically push local
463
# commits to the remote branch if they would fit.
464
# But for now, just require remote to be identical
467
# Make sure the local branch is identical to the master
468
master_info = self.master_branch.last_revision_info()
469
local_info = self.branch.last_revision_info()
470
if local_info != master_info:
471
raise errors.BoundBranchOutOfDate(self.branch,
474
# Now things are ready to change the master branch
476
self.bound_branch = self.branch
477
self.master_branch.lock_write()
478
self.master_locked = True
481
"""Cleanup any open locks, progress bars etc."""
482
cleanups = [self._cleanup_bound_branch,
483
self.basis_tree.unlock,
484
self.work_tree.unlock,
486
found_exception = None
487
for cleanup in cleanups:
490
# we want every cleanup to run no matter what.
491
# so we have a catchall here, but we will raise the
492
# last encountered exception up the stack: and
493
# typically this will be useful enough.
496
if found_exception is not None:
497
# don't do a plan raise, because the last exception may have been
498
# trashed, e is our sure-to-work exception even though it loses the
499
# full traceback. XXX: RBC 20060421 perhaps we could check the
500
# exc_info and if its the same one do a plain raise otherwise
501
# 'raise e' as we do now.
504
def _cleanup_bound_branch(self):
505
"""Executed at the end of a try/finally to cleanup a bound branch.
507
If the branch wasn't bound, this is a no-op.
508
If it was, it resents self.branch to the local branch, instead
511
if not self.bound_branch:
513
if self.master_locked:
514
self.master_branch.unlock()
296
516
def _escape_commit_message(self):
297
517
"""Replace xml-incompatible control characters."""
518
# FIXME: RBC 20060419 this should be done by the revision
519
# serialiser not by commit. Then we can also add an unescaper
520
# in the deserializer and start roundtripping revision messages
521
# precisely. See repository_implementations/test_repository.py
298
523
# Python strings can include characters that can't be
299
524
# represented in well-formed XML; escape characters that
300
525
# aren't listed in the XML specification
309
534
def _gather_parents(self):
310
535
"""Record the parents of a merge for merge detection."""
311
pending_merges = self.work_tree.pending_merges()
313
self.parent_invs = []
314
self.present_parents = []
315
precursor_id = self.branch.last_revision()
317
self.parents.append(precursor_id)
318
self.parents += pending_merges
319
for revision in self.parents:
320
if self.branch.has_revision(revision):
321
self.parent_invs.append(self.branch.get_inventory(revision))
322
self.present_parents.append(revision)
324
def _check_parents_present(self):
325
for parent_id in self.parents:
326
mutter('commit parent revision {%s}', parent_id)
327
if not self.branch.has_revision(parent_id):
328
if parent_id == self.branch.last_revision():
329
warning("parent is missing %r", parent_id)
330
raise HistoryMissing(self.branch, 'revision', parent_id)
332
mutter("commit will ghost revision %r", parent_id)
334
def _make_revision(self):
335
"""Record a new revision object for this commit."""
336
self.rev = Revision(timestamp=self.timestamp,
337
timezone=self.timezone,
338
committer=self.committer,
339
message=self.message,
340
inventory_sha1=self.inv_sha1,
341
revision_id=self.rev_id,
342
properties=self.revprops)
343
self.rev.parent_ids = self.parents
345
serializer_v5.write_revision(self.rev, rev_tmp)
347
if self.config.signature_needed():
348
plaintext = Testament(self.rev, self.new_inv).as_short_text()
349
self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
350
plaintext, self.rev_id)
351
self.branch.revision_store.add(rev_tmp, self.rev_id)
352
mutter('new revision_id is {%s}', self.rev_id)
536
# TODO: Make sure that this list doesn't contain duplicate
537
# entries and the order is preserved when doing this.
538
self.parents = self.work_tree.get_parent_ids()
539
self.parent_invs = [self.basis_inv]
540
for revision in self.parents[1:]:
541
if self.branch.repository.has_revision(revision):
542
mutter('commit parent revision {%s}', revision)
543
inventory = self.branch.repository.get_inventory(revision)
544
self.parent_invs.append(inventory)
546
mutter('commit parent ghost revision {%s}', revision)
354
548
def _remove_deleted(self):
355
549
"""Remove deleted files from the working inventories.
365
559
specific = self.specific_files
561
deleted_paths = set()
367
562
for path, ie in self.work_inv.iter_entries():
563
if is_inside_any(deleted_paths, path):
564
# The tree will delete the required ids recursively.
368
566
if specific and not is_inside_any(specific, path):
370
568
if not self.work_tree.has_filename(path):
569
deleted_paths.add(path)
371
570
self.reporter.missing(path)
372
deleted_ids.append((path, ie.file_id))
374
deleted_ids.sort(reverse=True)
375
for path, file_id in deleted_ids:
376
del self.work_inv[file_id]
377
self.work_tree._write_inventory(self.work_inv)
379
def _store_snapshot(self):
380
"""Pass over inventory and record a snapshot.
382
Entries get a new revision when they are modified in
383
any way, which includes a merge with a new set of
384
parents that have the same entry.
386
# XXX: Need to think more here about when the user has
387
# made a specific decision on a particular value -- c.f.
389
for path, ie in self.new_inv.iter_entries():
390
previous_entries = ie.find_previous_heads(
392
self.weave_store.get_weave_or_empty(ie.file_id,
393
self.branch.get_transaction()))
394
if ie.revision is None:
395
change = ie.snapshot(self.rev_id, path, previous_entries,
396
self.work_tree, self.weave_store,
397
self.branch.get_transaction())
400
self.reporter.snapshot_change(change, path)
571
deleted_ids.append(ie.file_id)
572
self.work_tree.unversion(deleted_ids)
402
574
def _populate_new_inv(self):
403
575
"""Build revision inventory.
409
581
None; inventory entries that are carried over untouched have their
410
582
revision set to their prior value.
584
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
585
# results to create a new inventory at the same time, which results
586
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
412
588
mutter("Selecting files for commit with filter %s", self.specific_files)
413
self.new_inv = Inventory()
414
for path, new_ie in self.work_inv.iter_entries():
589
assert self.work_inv.root is not None
590
entries = self.work_inv.iter_entries()
591
if not self.builder.record_root_entry:
592
symbol_versioning.warn('CommitBuilders should support recording'
593
' the root entry as of bzr 0.10.', DeprecationWarning,
595
self.builder.new_inventory.add(self.basis_inv.root.copy())
597
self._emit_progress_update()
598
for path, new_ie in entries:
599
self._emit_progress_update()
415
600
file_id = new_ie.file_id
416
mutter('check %s {%s}', path, new_ie.file_id)
417
if self.specific_files:
418
if not is_inside_any(self.specific_files, path):
419
mutter('%s not selected for commit', path)
420
self._carry_entry(file_id)
602
kind = self.work_tree.kind(file_id)
603
if kind == 'tree-reference' and self.recursive == 'down':
604
# nested tree: commit in it
605
sub_tree = WorkingTree.open(self.work_tree.abspath(path))
606
# FIXME: be more comprehensive here:
607
# this works when both trees are in --trees repository,
608
# but when both are bound to a different repository,
609
# it fails; a better way of approaching this is to
610
# finally implement the explicit-caches approach design
611
# a while back - RBC 20070306.
612
if (sub_tree.branch.repository.bzrdir.root_transport.base
614
self.work_tree.branch.repository.bzrdir.root_transport.base):
615
sub_tree.branch.repository = \
616
self.work_tree.branch.repository
618
sub_tree.commit(message=None, revprops=self.revprops,
619
recursive=self.recursive,
620
message_callback=self.message_callback,
621
timestamp=self.timestamp, timezone=self.timezone,
622
committer=self.committer,
623
allow_pointless=self.allow_pointless,
624
strict=self.strict, verbose=self.verbose,
625
local=self.local, reporter=self.reporter)
626
except errors.PointlessCommit:
628
if kind != new_ie.kind:
629
new_ie = inventory.make_entry(kind, new_ie.name,
630
new_ie.parent_id, file_id)
631
except errors.NoSuchFile:
633
# mutter('check %s {%s}', path, file_id)
634
if (not self.specific_files or
635
is_inside_or_parent_of_any(self.specific_files, path)):
636
# mutter('%s selected for commit', path)
640
# mutter('%s not selected for commit', path)
641
if self.basis_inv.has_id(file_id):
642
ie = self.basis_inv[file_id].copy()
644
# this entry is new and not being committed
423
# this is selected, ensure its parents are too.
424
parent_id = new_ie.parent_id
425
while parent_id != ROOT_ID:
426
if not self.new_inv.has_id(parent_id):
427
ie = self._select_entry(self.work_inv[parent_id])
428
mutter('%s selected for commit because of %s',
429
self.new_inv.id2path(parent_id), path)
431
ie = self.new_inv[parent_id]
432
if ie.revision is not None:
434
mutter('%s selected for commit because of %s',
435
self.new_inv.id2path(parent_id), path)
436
parent_id = ie.parent_id
437
mutter('%s selected for commit', path)
438
self._select_entry(new_ie)
440
def _select_entry(self, new_ie):
441
"""Make new_ie be considered for committing."""
447
def _carry_entry(self, file_id):
448
"""Carry the file unchanged from the basis revision."""
449
if self.basis_inv.has_id(file_id):
450
self.new_inv.add(self.basis_inv[file_id].copy())
646
self.builder.record_entry_contents(ie, self.parent_invs,
647
path, self.work_tree)
648
# describe the nature of the change that has occurred relative to
649
# the basis inventory.
650
if (self.basis_inv.has_id(ie.file_id)):
651
basis_ie = self.basis_inv[ie.file_id]
654
change = ie.describe_change(basis_ie, ie)
655
if change in (InventoryEntry.RENAMED,
656
InventoryEntry.MODIFIED_AND_RENAMED):
657
old_path = self.basis_inv.id2path(ie.file_id)
658
self.reporter.renamed(change, old_path, path)
660
self.reporter.snapshot_change(change, path)
662
if not self.specific_files:
665
# ignore removals that don't match filespec
666
for path, new_ie in self.basis_inv.iter_entries():
667
if new_ie.file_id in self.work_inv:
669
if is_inside_any(self.specific_files, path):
673
self.builder.record_entry_contents(ie, self.parent_invs, path,
676
def _emit_progress_update(self):
677
"""Emit an update to the progress bar."""
678
self.pb.update("Committing", self.pb_count, self.pb_total)
452
681
def _report_deletes(self):
453
for file_id in self.basis_inv:
454
if file_id not in self.new_inv:
455
self.reporter.deleted(self.basis_inv.id2path(file_id))
457
def _gen_revision_id(config, when):
458
"""Return new revision-id."""
459
s = '%s-%s-' % (config.user_email(), compact_date(when))
460
s += hexlify(rand_bytes(8))
682
for path, ie in self.basis_inv.iter_entries():
683
if ie.file_id not in self.builder.new_inventory:
684
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
