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.atomicfile import AtomicFile
76
from bzrlib.osutils import (local_time_offset,
77
rand_bytes, compact_date,
78
kind_marker, is_inside_any, quotefn,
79
sha_file, isdir, isfile,
64
from bzrlib.branch import Branch
81
65
import bzrlib.config
82
import bzrlib.errors as errors
83
66
from bzrlib.errors import (BzrError, PointlessCommit,
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.symbol_versioning import *
76
from bzrlib.inventory import Inventory, InventoryEntry
77
from bzrlib import symbol_versioning
78
from bzrlib.symbol_versioning import (deprecated_passed,
94
81
from bzrlib.workingtree import WorkingTree
97
@deprecated_function(zero_seven)
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)
109
85
class NullCommitReporter(object):
211
199
revprops -- Properties for new revision
212
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.
214
204
mutter('preparing to commit')
216
if deprecated_passed(branch):
217
warn("Commit.commit (branch, ...): The branch parameter is "
218
"deprecated as of bzr 0.8. Please use working_tree= instead.",
219
DeprecationWarning, stacklevel=2)
221
self.work_tree = self.branch.bzrdir.open_workingtree()
222
elif working_tree is None:
223
raise BzrError("One of branch and working_tree must be passed into commit().")
206
if working_tree is None:
207
raise BzrError("working_tree must be passed into commit().")
225
209
self.work_tree = working_tree
226
210
self.branch = self.work_tree.branch
228
raise BzrError("The message keyword parameter is required for commit().")
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().")
230
self.weave_store = self.branch.repository.weave_store
231
223
self.bound_branch = None
232
224
self.local = local
233
225
self.master_branch = None
234
226
self.master_locked = False
236
228
self.specific_files = specific_files
237
229
self.allow_pointless = allow_pointless
239
if revprops is not None:
240
self.revprops.update(revprops)
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
242
241
if reporter is None and self.reporter is None:
243
242
self.reporter = NullCommitReporter()
245
244
self.reporter = reporter
247
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()
251
# Cannot commit with conflicts present.
252
if len(self.work_tree.conflicts())>0:
253
raise ConflictsInTree
249
255
# setup the bound branch variables as needed.
250
256
self._check_bound_branch()
252
258
# check for out of date working trees
253
# if we are bound, then self.branch is the master branch and this
254
# test is thus all we need.
255
if self.work_tree.last_revision() != self.master_branch.last_revision():
256
raise errors.OutOfDateTree(self.work_tree)
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.
259
277
# raise an exception as soon as we find a single unknown.
260
278
for unknown in self.work_tree.unknowns():
261
279
raise StrictCommitFailed()
263
if timestamp is None:
264
self.timestamp = time.time()
266
self.timestamp = long(timestamp)
268
281
if self.config is None:
269
self.config = bzrlib.config.BranchConfig(self.branch)
272
self.rev_id = _gen_revision_id(self.config, self.timestamp)
276
if committer is None:
277
self.committer = self.config.username()
279
assert isinstance(committer, basestring), type(committer)
280
self.committer = committer
283
self.timezone = local_time_offset()
285
self.timezone = int(timezone)
287
if isinstance(message, str):
288
message = message.decode(bzrlib.user_encoding)
289
assert isinstance(message, unicode), type(message)
290
self.message = message
291
self._escape_commit_message()
282
self.config = self.branch.get_config()
293
284
self.work_inv = self.work_tree.inventory
294
self.basis_tree = self.work_tree.basis_tree()
295
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
297
301
self._gather_parents()
298
302
if len(self.parents) > 1 and self.specific_files:
299
raise NotImplementedError('selected-file commit of merges is not supported yet')
300
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)
302
309
self._remove_deleted()
303
310
self._populate_new_inv()
304
self._store_snapshot()
305
311
self._report_deletes()
307
if not (self.allow_pointless
308
or len(self.parents) > 1
309
or self.new_inv != self.basis_inv):
310
raise PointlessCommit()
312
if len(self.work_tree.conflicts())>0:
313
raise ConflictsInTree
315
self.inv_sha1 = self.branch.repository.add_inventory(
320
self._make_revision()
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()
321
330
# revision data is in the local branch now.
323
332
# upload revision data to the master.
324
# this will propogate merged revisions too if needed.
333
# this will propagate merged revisions too if needed.
325
334
if self.bound_branch:
326
335
self.master_branch.repository.fetch(self.branch.repository,
327
336
revision_id=self.rev_id)
328
337
# now the master has the revision data
329
338
# 'commit' to the master first so a timeout here causes the local
330
339
# branch to be out of date
331
self.master_branch.append_revision(self.rev_id)
340
self.master_branch.set_last_revision_info(new_revno,
333
343
# and now do the commit locally.
334
self.branch.append_revision(self.rev_id)
344
self.branch.set_last_revision_info(new_revno, self.rev_id)
336
self.work_tree.set_pending_merges([])
337
self.work_tree.set_last_revision(self.rev_id)
346
rev_tree = self.builder.revision_tree()
347
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
338
348
# now the work tree is up to date with the branch
340
self.reporter.completed(self.branch.revno(), self.rev_id)
350
self.reporter.completed(new_revno, self.rev_id)
351
# old style commit hooks - should be deprecated ? (obsoleted in
341
353
if self.config.post_commit() is not None:
342
354
hooks = self.config.post_commit().split(' ')
343
355
# this would be nicer with twisted.python.reflect.namedAny
346
358
{'branch':self.branch,
348
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()
350
self._cleanup_bound_branch()
351
self.work_tree.unlock()
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()
353
438
def _check_bound_branch(self):
354
439
"""Check to see if the local branch is bound.
391
476
self.bound_branch = self.branch
392
477
self.master_branch.lock_write()
393
478
self.master_locked = True
395
#### # Check to see if we have any pending merges. If we do
396
#### # those need to be pushed into the master branch
397
#### pending_merges = self.work_tree.pending_merges()
398
#### if pending_merges:
399
#### for revision_id in pending_merges:
400
#### self.master_branch.repository.fetch(self.bound_branch.repository,
401
#### revision_id=revision_id)
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.
403
504
def _cleanup_bound_branch(self):
404
505
"""Executed at the end of a try/finally to cleanup a bound branch.
428
534
def _gather_parents(self):
429
535
"""Record the parents of a merge for merge detection."""
430
pending_merges = self.work_tree.pending_merges()
432
self.parent_invs = []
433
self.present_parents = []
434
precursor_id = self.branch.last_revision()
436
self.parents.append(precursor_id)
437
self.parents += pending_merges
438
for revision in self.parents:
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:]:
439
541
if self.branch.repository.has_revision(revision):
542
mutter('commit parent revision {%s}', revision)
440
543
inventory = self.branch.repository.get_inventory(revision)
441
544
self.parent_invs.append(inventory)
442
self.present_parents.append(revision)
444
def _check_parents_present(self):
445
for parent_id in self.parents:
446
mutter('commit parent revision {%s}', parent_id)
447
if not self.branch.repository.has_revision(parent_id):
448
if parent_id == self.branch.last_revision():
449
warning("parent is missing %r", parent_id)
450
raise HistoryMissing(self.branch, 'revision', parent_id)
452
mutter("commit will ghost revision %r", parent_id)
454
def _make_revision(self):
455
"""Record a new revision object for this commit."""
456
rev = Revision(timestamp=self.timestamp,
457
timezone=self.timezone,
458
committer=self.committer,
459
message=self.message,
460
inventory_sha1=self.inv_sha1,
461
revision_id=self.rev_id,
462
properties=self.revprops)
463
rev.parent_ids = self.parents
464
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
546
mutter('commit parent ghost revision {%s}', revision)
466
548
def _remove_deleted(self):
467
549
"""Remove deleted files from the working inventories.
477
559
specific = self.specific_files
561
deleted_paths = set()
479
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.
480
566
if specific and not is_inside_any(specific, path):
482
568
if not self.work_tree.has_filename(path):
569
deleted_paths.add(path)
483
570
self.reporter.missing(path)
484
deleted_ids.append((path, ie.file_id))
486
deleted_ids.sort(reverse=True)
487
for path, file_id in deleted_ids:
488
del self.work_inv[file_id]
489
self.work_tree._write_inventory(self.work_inv)
491
def _store_snapshot(self):
492
"""Pass over inventory and record a snapshot.
494
Entries get a new revision when they are modified in
495
any way, which includes a merge with a new set of
496
parents that have the same entry.
498
# XXX: Need to think more here about when the user has
499
# made a specific decision on a particular value -- c.f.
501
for path, ie in self.new_inv.iter_entries():
502
previous_entries = ie.find_previous_heads(
505
self.branch.repository.get_transaction())
506
if ie.revision is None:
507
change = ie.snapshot(self.rev_id, path, previous_entries,
508
self.work_tree, self.weave_store,
509
self.branch.get_transaction())
512
self.reporter.snapshot_change(change, path)
571
deleted_ids.append(ie.file_id)
572
self.work_tree.unversion(deleted_ids)
514
574
def _populate_new_inv(self):
515
575
"""Build revision inventory.
521
581
None; inventory entries that are carried over untouched have their
522
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?
524
588
mutter("Selecting files for commit with filter %s", self.specific_files)
525
self.new_inv = Inventory(revision_id=self.rev_id)
526
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()
527
600
file_id = new_ie.file_id
528
mutter('check %s {%s}', path, new_ie.file_id)
529
if self.specific_files:
530
if not is_inside_any(self.specific_files, path):
531
mutter('%s not selected for commit', path)
532
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
535
# this is selected, ensure its parents are too.
536
parent_id = new_ie.parent_id
537
while parent_id != ROOT_ID:
538
if not self.new_inv.has_id(parent_id):
539
ie = self._select_entry(self.work_inv[parent_id])
540
mutter('%s selected for commit because of %s',
541
self.new_inv.id2path(parent_id), path)
543
ie = self.new_inv[parent_id]
544
if ie.revision is not None:
546
mutter('%s selected for commit because of %s',
547
self.new_inv.id2path(parent_id), path)
548
parent_id = ie.parent_id
549
mutter('%s selected for commit', path)
550
self._select_entry(new_ie)
552
def _select_entry(self, new_ie):
553
"""Make new_ie be considered for committing."""
559
def _carry_entry(self, file_id):
560
"""Carry the file unchanged from the basis revision."""
561
if self.basis_inv.has_id(file_id):
562
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)
564
681
def _report_deletes(self):
565
for file_id in self.basis_inv:
566
if file_id not in self.new_inv:
567
self.reporter.deleted(self.basis_inv.id2path(file_id))
569
def _gen_revision_id(config, when):
570
"""Return new revision-id."""
571
s = '%s-%s-' % (config.user_email(), compact_date(when))
572
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
