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):
245
237
self.reporter = reporter
247
239
self.work_tree.lock_write()
240
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
241
self.basis_tree = self.work_tree.basis_tree()
242
self.basis_tree.lock_read()
244
# Cannot commit with conflicts present.
245
if len(self.work_tree.conflicts())>0:
246
raise ConflictsInTree
249
248
# setup the bound branch variables as needed.
250
249
self._check_bound_branch()
252
251
# 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)
253
first_tree_parent = self.work_tree.get_parent_ids()[0]
255
# if there are no parents, treat our parent as 'None'
256
# this is so that we still consier the master branch
257
# - in a checkout scenario the tree may have no
258
# parents but the branch may do.
259
first_tree_parent = bzrlib.revision.NULL_REVISION
260
old_revno, master_last = self.master_branch.last_revision_info()
261
if master_last != first_tree_parent:
262
if master_last != bzrlib.revision.NULL_REVISION:
263
raise errors.OutOfDateTree(self.work_tree)
264
if self.branch.repository.has_revision(first_tree_parent):
265
new_revno = old_revno + 1
267
# ghost parents never appear in revision history.
259
270
# raise an exception as soon as we find a single unknown.
260
271
for unknown in self.work_tree.unknowns():
261
272
raise StrictCommitFailed()
263
if timestamp is None:
264
self.timestamp = time.time()
266
self.timestamp = long(timestamp)
268
274
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()
275
self.config = self.branch.get_config()
293
277
self.work_inv = self.work_tree.inventory
294
self.basis_tree = self.work_tree.basis_tree()
295
278
self.basis_inv = self.basis_tree.inventory
279
if specific_files is not None:
280
# Ensure specified files are versioned
281
# (We don't actually need the ids here)
282
tree.find_ids_across_trees(specific_files,
283
[self.basis_tree, self.work_tree])
284
# one to finish, one for rev and inventory, and one for each
285
# inventory entry, and the same for the new inventory.
286
# note that this estimate is too long when we do a partial tree
287
# commit which excludes some new files from being considered.
288
# The estimate is corrected when we populate the new inv.
289
self.pb_total = len(self.work_inv) + 5
297
292
self._gather_parents()
298
293
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()
294
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
297
self.builder = self.branch.get_commit_builder(self.parents,
298
self.config, timestamp, timezone, committer, revprops, rev_id)
302
300
self._remove_deleted()
303
301
self._populate_new_inv()
304
self._store_snapshot()
305
302
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()
304
self._check_pointless()
306
self._emit_progress_update()
307
# TODO: Now the new inventory is known, check for conflicts and
308
# prompt the user for a commit message.
309
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
310
# weave lines, because nothing should be recorded until it is known
311
# that commit will succeed.
312
self.builder.finish_inventory()
313
self._emit_progress_update()
314
message = message_callback(self)
315
assert isinstance(message, unicode), type(message)
316
self.message = message
317
self._escape_commit_message()
319
self.rev_id = self.builder.commit(self.message)
320
self._emit_progress_update()
321
321
# revision data is in the local branch now.
323
323
# upload revision data to the master.
324
# this will propogate merged revisions too if needed.
324
# this will propagate merged revisions too if needed.
325
325
if self.bound_branch:
326
326
self.master_branch.repository.fetch(self.branch.repository,
327
327
revision_id=self.rev_id)
328
328
# now the master has the revision data
329
329
# 'commit' to the master first so a timeout here causes the local
330
330
# branch to be out of date
331
self.master_branch.append_revision(self.rev_id)
331
self.master_branch.set_last_revision_info(new_revno,
333
334
# and now do the commit locally.
334
self.branch.append_revision(self.rev_id)
335
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)
337
rev_tree = self.builder.revision_tree()
338
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
338
339
# now the work tree is up to date with the branch
340
self.reporter.completed(self.branch.revno(), self.rev_id)
341
self.reporter.completed(new_revno, self.rev_id)
342
# old style commit hooks - should be deprecated ? (obsoleted in
341
344
if self.config.post_commit() is not None:
342
345
hooks = self.config.post_commit().split(' ')
343
346
# this would be nicer with twisted.python.reflect.namedAny
346
349
{'branch':self.branch,
348
351
'rev_id':self.rev_id})
352
# new style commit hooks:
353
if not self.bound_branch:
354
hook_master = self.branch
357
hook_master = self.master_branch
358
hook_local = self.branch
359
# With bound branches, when the master is behind the local branch,
360
# the 'old_revno' and old_revid values here are incorrect.
361
# XXX: FIXME ^. RBC 20060206
363
old_revid = self.parents[0]
365
old_revid = bzrlib.revision.NULL_REVISION
366
for hook in Branch.hooks['post_commit']:
367
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
369
self._emit_progress_update()
350
self._cleanup_bound_branch()
351
self.work_tree.unlock()
374
def _any_real_changes(self):
375
"""Are there real changes between new_inventory and basis?
377
For trees without rich roots, inv.root.revision changes every commit.
378
But if that is the only change, we want to treat it as though there
381
new_entries = self.builder.new_inventory.iter_entries()
382
basis_entries = self.basis_inv.iter_entries()
383
new_path, new_root_ie = new_entries.next()
384
basis_path, basis_root_ie = basis_entries.next()
386
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
387
def ie_equal_no_revision(this, other):
388
return ((this.file_id == other.file_id)
389
and (this.name == other.name)
390
and (this.symlink_target == other.symlink_target)
391
and (this.text_sha1 == other.text_sha1)
392
and (this.text_size == other.text_size)
393
and (this.text_id == other.text_id)
394
and (this.parent_id == other.parent_id)
395
and (this.kind == other.kind)
396
and (this.executable == other.executable)
398
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
401
for new_ie, basis_ie in zip(new_entries, basis_entries):
402
if new_ie != basis_ie:
405
# No actual changes present
408
def _check_pointless(self):
409
if self.allow_pointless:
411
# A merge with no effect on files
412
if len(self.parents) > 1:
414
# work around the fact that a newly-initted tree does differ from its
416
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
417
raise PointlessCommit()
418
# Shortcut, if the number of entries changes, then we obviously have
420
if len(self.builder.new_inventory) != len(self.basis_inv):
422
# If length == 1, then we only have the root entry. Which means
423
# that there is no real difference (only the root could be different)
424
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
426
raise PointlessCommit()
353
428
def _check_bound_branch(self):
354
429
"""Check to see if the local branch is bound.
391
466
self.bound_branch = self.branch
392
467
self.master_branch.lock_write()
393
468
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)
471
"""Cleanup any open locks, progress bars etc."""
472
cleanups = [self._cleanup_bound_branch,
473
self.basis_tree.unlock,
474
self.work_tree.unlock,
476
found_exception = None
477
for cleanup in cleanups:
480
# we want every cleanup to run no matter what.
481
# so we have a catchall here, but we will raise the
482
# last encountered exception up the stack: and
483
# typically this will be useful enough.
486
if found_exception is not None:
487
# don't do a plan raise, because the last exception may have been
488
# trashed, e is our sure-to-work exception even though it loses the
489
# full traceback. XXX: RBC 20060421 perhaps we could check the
490
# exc_info and if its the same one do a plain raise otherwise
491
# 'raise e' as we do now.
403
494
def _cleanup_bound_branch(self):
404
495
"""Executed at the end of a try/finally to cleanup a bound branch.
428
524
def _gather_parents(self):
429
525
"""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:
526
# TODO: Make sure that this list doesn't contain duplicate
527
# entries and the order is preserved when doing this.
528
self.parents = self.work_tree.get_parent_ids()
529
self.parent_invs = [self.basis_inv]
530
for revision in self.parents[1:]:
439
531
if self.branch.repository.has_revision(revision):
532
mutter('commit parent revision {%s}', revision)
440
533
inventory = self.branch.repository.get_inventory(revision)
441
534
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)
536
mutter('commit parent ghost revision {%s}', revision)
466
538
def _remove_deleted(self):
467
539
"""Remove deleted files from the working inventories.
477
549
specific = self.specific_files
551
deleted_paths = set()
479
552
for path, ie in self.work_inv.iter_entries():
553
if is_inside_any(deleted_paths, path):
554
# The tree will delete the required ids recursively.
480
556
if specific and not is_inside_any(specific, path):
482
558
if not self.work_tree.has_filename(path):
559
deleted_paths.add(path)
483
560
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)
561
deleted_ids.append(ie.file_id)
562
self.work_tree.unversion(deleted_ids)
514
564
def _populate_new_inv(self):
515
565
"""Build revision inventory.
521
571
None; inventory entries that are carried over untouched have their
522
572
revision set to their prior value.
574
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
575
# results to create a new inventory at the same time, which results
576
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
524
578
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():
579
assert self.work_inv.root is not None
580
entries = self.work_inv.iter_entries()
581
if not self.builder.record_root_entry:
582
symbol_versioning.warn('CommitBuilders should support recording'
583
' the root entry as of bzr 0.10.', DeprecationWarning,
585
self.builder.new_inventory.add(self.basis_inv.root.copy())
587
self._emit_progress_update()
588
for path, new_ie in entries:
589
self._emit_progress_update()
527
590
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)
592
kind = self.work_tree.kind(file_id)
593
if kind != new_ie.kind:
594
new_ie = inventory.make_entry(kind, new_ie.name,
595
new_ie.parent_id, file_id)
596
except errors.NoSuchFile:
598
# mutter('check %s {%s}', path, file_id)
599
if (not self.specific_files or
600
is_inside_or_parent_of_any(self.specific_files, path)):
601
# mutter('%s selected for commit', path)
605
# mutter('%s not selected for commit', path)
606
if self.basis_inv.has_id(file_id):
607
ie = self.basis_inv[file_id].copy()
609
# 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())
611
self.builder.record_entry_contents(ie, self.parent_invs,
612
path, self.work_tree)
613
# describe the nature of the change that has occurred relative to
614
# the basis inventory.
615
if (self.basis_inv.has_id(ie.file_id)):
616
basis_ie = self.basis_inv[ie.file_id]
619
change = ie.describe_change(basis_ie, ie)
620
if change in (InventoryEntry.RENAMED,
621
InventoryEntry.MODIFIED_AND_RENAMED):
622
old_path = self.basis_inv.id2path(ie.file_id)
623
self.reporter.renamed(change, old_path, path)
625
self.reporter.snapshot_change(change, path)
627
if not self.specific_files:
630
# ignore removals that don't match filespec
631
for path, new_ie in self.basis_inv.iter_entries():
632
if new_ie.file_id in self.work_inv:
634
if is_inside_any(self.specific_files, path):
638
self.builder.record_entry_contents(ie, self.parent_invs, path,
641
def _emit_progress_update(self):
642
"""Emit an update to the progress bar."""
643
self.pb.update("Committing", self.pb_count, self.pb_total)
564
646
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))
647
for path, ie in self.basis_inv.iter_entries():
648
if ie.file_id not in self.builder.new_inventory:
649
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
