72
from binascii import hexlify
73
70
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,
81
72
import bzrlib.config
82
73
import bzrlib.errors as errors
83
74
from bzrlib.errors import (BzrError, PointlessCommit,
88
from bzrlib.revision import Revision
78
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
79
is_inside_or_parent_of_any,
80
quotefn, sha_file, split_lines)
89
81
from bzrlib.testament import Testament
90
82
from bzrlib.trace import mutter, note, warning
91
83
from bzrlib.xml5 import serializer_v5
92
from bzrlib.inventory import Inventory, ROOT_ID
93
from bzrlib.symbol_versioning import *
84
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
85
from bzrlib import symbol_versioning
86
from bzrlib.symbol_versioning import (deprecated_passed,
94
89
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
92
class NullCommitReporter(object):
110
93
"""I report on progress of a commit."""
245
235
self.reporter = reporter
247
237
self.work_tree.lock_write()
238
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
240
# Cannot commit with conflicts present.
241
if len(self.work_tree.conflicts())>0:
242
raise ConflictsInTree
249
244
# setup the bound branch variables as needed.
250
245
self._check_bound_branch()
252
247
# 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():
249
first_tree_parent = self.work_tree.get_parent_ids()[0]
251
# if there are no parents, treat our parent as 'None'
252
# this is so that we still consier the master branch
253
# - in a checkout scenario the tree may have no
254
# parents but the branch may do.
255
first_tree_parent = None
256
master_last = self.master_branch.last_revision()
257
if (master_last is not None and
258
master_last != first_tree_parent):
256
259
raise errors.OutOfDateTree(self.work_tree)
259
262
# raise an exception as soon as we find a single unknown.
260
263
for unknown in self.work_tree.unknowns():
261
264
raise StrictCommitFailed()
263
if timestamp is None:
264
self.timestamp = time.time()
266
self.timestamp = long(timestamp)
268
266
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)
267
self.config = self.branch.get_config()
287
269
if isinstance(message, str):
288
270
message = message.decode(bzrlib.user_encoding)
289
271
assert isinstance(message, unicode), type(message)
293
275
self.work_inv = self.work_tree.inventory
294
276
self.basis_tree = self.work_tree.basis_tree()
295
277
self.basis_inv = self.basis_tree.inventory
278
# one to finish, one for rev and inventory, and one for each
279
# inventory entry, and the same for the new inventory.
280
# note that this estimate is too long when we do a partial tree
281
# commit which excludes some new files from being considered.
282
# The estimate is corrected when we populate the new inv.
283
self.pb_total = len(self.work_inv) + 5
297
286
self._gather_parents()
298
287
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()
288
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
291
self.builder = self.branch.get_commit_builder(self.parents,
292
self.config, timestamp, timezone, committer, revprops, rev_id)
302
294
self._remove_deleted()
303
295
self._populate_new_inv()
304
self._store_snapshot()
305
296
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()
298
self._check_pointless()
300
self._emit_progress_update()
301
# TODO: Now the new inventory is known, check for conflicts and
302
# prompt the user for a commit message.
303
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
304
# weave lines, because nothing should be recorded until it is known
305
# that commit will succeed.
306
self.builder.finish_inventory()
307
self._emit_progress_update()
308
self.rev_id = self.builder.commit(self.message)
309
self._emit_progress_update()
321
310
# revision data is in the local branch now.
323
312
# upload revision data to the master.
324
# this will propogate merged revisions too if needed.
313
# this will propagate merged revisions too if needed.
325
314
if self.bound_branch:
326
315
self.master_branch.repository.fetch(self.branch.repository,
327
316
revision_id=self.rev_id)
391
399
self.bound_branch = self.branch
392
400
self.master_branch.lock_write()
393
401
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)
404
"""Cleanup any open locks, progress bars etc."""
405
cleanups = [self._cleanup_bound_branch,
406
self.work_tree.unlock,
408
found_exception = None
409
for cleanup in cleanups:
412
# we want every cleanup to run no matter what.
413
# so we have a catchall here, but we will raise the
414
# last encountered exception up the stack: and
415
# typically this will be useful enough.
418
if found_exception is not None:
419
# don't do a plan raise, because the last exception may have been
420
# trashed, e is our sure-to-work exception even though it loses the
421
# full traceback. XXX: RBC 20060421 perhaps we could check the
422
# exc_info and if its the same one do a plain raise otherwise
423
# 'raise e' as we do now.
403
426
def _cleanup_bound_branch(self):
404
427
"""Executed at the end of a try/finally to cleanup a bound branch.
428
456
def _gather_parents(self):
429
457
"""Record the parents of a merge for merge detection."""
430
pending_merges = self.work_tree.pending_merges()
458
# TODO: Make sure that this list doesn't contain duplicate
459
# entries and the order is preserved when doing this.
460
self.parents = self.work_tree.get_parent_ids()
432
461
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
462
for revision in self.parents:
439
463
if self.branch.repository.has_revision(revision):
464
mutter('commit parent revision {%s}', revision)
440
465
inventory = self.branch.repository.get_inventory(revision)
441
466
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)
468
mutter('commit parent ghost revision {%s}', revision)
466
470
def _remove_deleted(self):
467
471
"""Remove deleted files from the working inventories.
477
481
specific = self.specific_files
483
deleted_paths = set()
479
484
for path, ie in self.work_inv.iter_entries():
485
if is_inside_any(deleted_paths, path):
486
# The tree will delete the required ids recursively.
480
488
if specific and not is_inside_any(specific, path):
482
490
if not self.work_tree.has_filename(path):
491
deleted_paths.add(path)
483
492
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)
493
deleted_ids.append(ie.file_id)
494
self.work_tree.unversion(deleted_ids)
514
496
def _populate_new_inv(self):
515
497
"""Build revision inventory.
521
503
None; inventory entries that are carried over untouched have their
522
504
revision set to their prior value.
506
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
507
# results to create a new inventory at the same time, which results
508
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
524
510
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():
511
entries = self.work_inv.iter_entries()
512
if not self.builder.record_root_entry:
513
symbol_versioning.warn('CommitBuilders should support recording'
514
' the root entry as of bzr 0.10.', DeprecationWarning,
516
self.builder.new_inventory.add(self.basis_inv.root.copy())
518
self._emit_progress_update()
519
for path, new_ie in entries:
520
self._emit_progress_update()
527
521
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)
522
# mutter('check %s {%s}', path, file_id)
523
if (not self.specific_files or
524
is_inside_or_parent_of_any(self.specific_files, path)):
525
# mutter('%s selected for commit', path)
529
# mutter('%s not selected for commit', path)
530
if self.basis_inv.has_id(file_id):
531
ie = self.basis_inv[file_id].copy()
533
# 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())
536
self.builder.record_entry_contents(ie, self.parent_invs,
537
path, self.work_tree)
538
# describe the nature of the change that has occurred relative to
539
# the basis inventory.
540
if (self.basis_inv.has_id(ie.file_id)):
541
basis_ie = self.basis_inv[ie.file_id]
544
change = ie.describe_change(basis_ie, ie)
545
if change in (InventoryEntry.RENAMED,
546
InventoryEntry.MODIFIED_AND_RENAMED):
547
old_path = self.basis_inv.id2path(ie.file_id)
548
self.reporter.renamed(change, old_path, path)
550
self.reporter.snapshot_change(change, path)
552
if not self.specific_files:
555
# ignore removals that don't match filespec
556
for path, new_ie in self.basis_inv.iter_entries():
557
if new_ie.file_id in self.work_inv:
559
if is_inside_any(self.specific_files, path):
563
self.builder.record_entry_contents(ie, self.parent_invs, path,
566
def _emit_progress_update(self):
567
"""Emit an update to the progress bar."""
568
self.pb.update("Committing", self.pb_count, self.pb_total)
564
571
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))
572
for path, ie in self.basis_inv.iter_entries():
573
if ie.file_id not in self.builder.new_inventory:
574
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
