63
62
# TODO: If commit fails, leave the message in a file somewhere.
64
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
65
# the rest of the code; add a deprecation of the old name.
72
from binascii import hexlify
73
72
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
81
78
import bzrlib.config
82
79
from bzrlib.errors import (BzrError, PointlessCommit,
87
import bzrlib.gpg as gpg
88
from bzrlib.revision import Revision
83
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
84
is_inside_or_parent_of_any,
85
quotefn, sha_file, split_lines)
89
86
from bzrlib.testament import Testament
90
87
from bzrlib.trace import mutter, note, warning
91
88
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)
89
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
90
from bzrlib import symbol_versioning
91
from bzrlib.symbol_versioning import (deprecated_passed,
94
from bzrlib.workingtree import WorkingTree
109
97
class NullCommitReporter(object):
196
208
contains unknown files.
198
210
revprops -- Properties for new revision
211
:param local: Perform a local only commit.
200
213
mutter('preparing to commit')
203
self.weave_store = branch.weave_store
215
if deprecated_passed(branch):
216
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
217
"deprecated as of bzr 0.8. Please use working_tree= instead.",
218
DeprecationWarning, stacklevel=2)
220
self.work_tree = self.branch.bzrdir.open_workingtree()
221
elif working_tree is None:
222
raise BzrError("One of branch and working_tree must be passed into commit().")
224
self.work_tree = working_tree
225
self.branch = self.work_tree.branch
227
raise BzrError("The message keyword parameter is required for commit().")
229
self.bound_branch = None
231
self.master_branch = None
232
self.master_locked = False
205
234
self.specific_files = specific_files
206
235
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()
237
if reporter is None and self.reporter is None:
238
self.reporter = NullCommitReporter()
239
elif reporter is not None:
240
self.reporter = reporter
242
self.work_tree.lock_write()
243
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
248
self.work_tree = self.branch.working_tree()
245
# Cannot commit with conflicts present.
246
if len(self.work_tree.conflicts())>0:
247
raise ConflictsInTree
249
# setup the bound branch variables as needed.
250
self._check_bound_branch()
252
# check for out of date working trees
254
first_tree_parent = self.work_tree.get_parent_ids()[0]
256
# if there are no parents, treat our parent as 'None'
257
# this is so that we still consier the master branch
258
# - in a checkout scenario the tree may have no
259
# parents but the branch may do.
260
first_tree_parent = None
261
master_last = self.master_branch.last_revision()
262
if (master_last is not None and
263
master_last != first_tree_parent):
264
raise errors.OutOfDateTree(self.work_tree)
267
# raise an exception as soon as we find a single unknown.
268
for unknown in self.work_tree.unknowns():
269
raise StrictCommitFailed()
271
if self.config is None:
272
self.config = self.branch.get_config()
274
if isinstance(message, str):
275
message = message.decode(bzrlib.user_encoding)
276
assert isinstance(message, unicode), type(message)
277
self.message = message
278
self._escape_commit_message()
249
280
self.work_inv = self.work_tree.inventory
250
self.basis_tree = self.branch.basis_tree()
281
self.basis_tree = self.work_tree.basis_tree()
251
282
self.basis_inv = self.basis_tree.inventory
283
if specific_files is not None:
284
# Ensure specified files are versioned
285
# (We don't actually need the ids here)
286
tree.find_ids_across_trees(specific_files,
287
[self.basis_tree, self.work_tree])
288
# one to finish, one for rev and inventory, and one for each
289
# inventory entry, and the same for the new inventory.
290
# note that this estimate is too long when we do a partial tree
291
# commit which excludes some new files from being considered.
292
# The estimate is corrected when we populate the new inv.
293
self.pb_total = len(self.work_inv) + 5
253
296
self._gather_parents()
254
297
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()
298
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
301
self.builder = self.branch.get_commit_builder(self.parents,
302
self.config, timestamp, timezone, committer, revprops, rev_id)
258
304
self._remove_deleted()
259
305
self._populate_new_inv()
260
self._store_snapshot()
261
306
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()
308
self._check_pointless()
310
self._emit_progress_update()
311
# TODO: Now the new inventory is known, check for conflicts and
312
# prompt the user for a commit message.
313
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
314
# weave lines, because nothing should be recorded until it is known
315
# that commit will succeed.
316
self.builder.finish_inventory()
317
self._emit_progress_update()
318
self.rev_id = self.builder.commit(self.message)
319
self._emit_progress_update()
320
# revision data is in the local branch now.
322
# upload revision data to the master.
323
# this will propagate merged revisions too if needed.
324
if self.bound_branch:
325
self.master_branch.repository.fetch(self.branch.repository,
326
revision_id=self.rev_id)
327
# now the master has the revision data
328
# 'commit' to the master first so a timeout here causes the local
329
# branch to be out of date
330
self.master_branch.append_revision(self.rev_id)
332
# and now do the commit locally.
273
333
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)
335
# if the builder gave us the revisiontree it created back, we
336
# could use it straight away here.
337
# TODO: implement this.
338
self.work_tree.set_parent_trees([(self.rev_id,
339
self.branch.repository.revision_tree(self.rev_id))])
340
# now the work tree is up to date with the branch
342
self.reporter.completed(self.branch.revno(), self.rev_id)
276
343
if self.config.post_commit() is not None:
277
344
hooks = self.config.post_commit().split(' ')
278
345
# this would be nicer with twisted.python.reflect.namedAny
281
348
{'branch':self.branch,
283
350
'rev_id':self.rev_id})
351
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())
356
def _check_pointless(self):
357
if self.allow_pointless:
359
# A merge with no effect on files
360
if len(self.parents) > 1:
362
# work around the fact that a newly-initted tree does differ from its
364
if len(self.builder.new_inventory) != len(self.basis_inv):
366
if (len(self.builder.new_inventory) != 1 and
367
self.builder.new_inventory != self.basis_inv):
369
raise PointlessCommit()
371
def _check_bound_branch(self):
372
"""Check to see if the local branch is bound.
374
If it is bound, then most of the commit will actually be
375
done using the remote branch as the target branch.
376
Only at the end will the local branch be updated.
378
if self.local and not self.branch.get_bound_location():
379
raise errors.LocalRequiresBoundBranch()
382
self.master_branch = self.branch.get_master_branch()
384
if not self.master_branch:
385
# make this branch the reference branch for out of date checks.
386
self.master_branch = self.branch
389
# If the master branch is bound, we must fail
390
master_bound_location = self.master_branch.get_bound_location()
391
if master_bound_location:
392
raise errors.CommitToDoubleBoundBranch(self.branch,
393
self.master_branch, master_bound_location)
395
# TODO: jam 20051230 We could automatically push local
396
# commits to the remote branch if they would fit.
397
# But for now, just require remote to be identical
400
# Make sure the local branch is identical to the master
401
master_rh = self.master_branch.revision_history()
402
local_rh = self.branch.revision_history()
403
if local_rh != master_rh:
404
raise errors.BoundBranchOutOfDate(self.branch,
407
# Now things are ready to change the master branch
409
self.bound_branch = self.branch
410
self.master_branch.lock_write()
411
self.master_locked = True
414
"""Cleanup any open locks, progress bars etc."""
415
cleanups = [self._cleanup_bound_branch,
416
self.work_tree.unlock,
418
found_exception = None
419
for cleanup in cleanups:
422
# we want every cleanup to run no matter what.
423
# so we have a catchall here, but we will raise the
424
# last encountered exception up the stack: and
425
# typically this will be useful enough.
428
if found_exception is not None:
429
# don't do a plan raise, because the last exception may have been
430
# trashed, e is our sure-to-work exception even though it loses the
431
# full traceback. XXX: RBC 20060421 perhaps we could check the
432
# exc_info and if its the same one do a plain raise otherwise
433
# 'raise e' as we do now.
436
def _cleanup_bound_branch(self):
437
"""Executed at the end of a try/finally to cleanup a bound branch.
439
If the branch wasn't bound, this is a no-op.
440
If it was, it resents self.branch to the local branch, instead
443
if not self.bound_branch:
445
if self.master_locked:
446
self.master_branch.unlock()
296
448
def _escape_commit_message(self):
297
449
"""Replace xml-incompatible control characters."""
450
# FIXME: RBC 20060419 this should be done by the revision
451
# serialiser not by commit. Then we can also add an unescaper
452
# in the deserializer and start roundtripping revision messages
453
# precisely. See repository_implementations/test_repository.py
298
455
# Python strings can include characters that can't be
299
456
# represented in well-formed XML; escape characters that
300
457
# aren't listed in the XML specification
309
466
def _gather_parents(self):
310
467
"""Record the parents of a merge for merge detection."""
311
pending_merges = self.work_tree.pending_merges()
468
# TODO: Make sure that this list doesn't contain duplicate
469
# entries and the order is preserved when doing this.
470
self.parents = self.work_tree.get_parent_ids()
313
471
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
472
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)
473
if self.branch.repository.has_revision(revision):
474
mutter('commit parent revision {%s}', revision)
475
inventory = self.branch.repository.get_inventory(revision)
476
self.parent_invs.append(inventory)
478
mutter('commit parent ghost revision {%s}', revision)
354
480
def _remove_deleted(self):
355
481
"""Remove deleted files from the working inventories.
365
491
specific = self.specific_files
493
deleted_paths = set()
367
494
for path, ie in self.work_inv.iter_entries():
495
if is_inside_any(deleted_paths, path):
496
# The tree will delete the required ids recursively.
368
498
if specific and not is_inside_any(specific, path):
370
500
if not self.work_tree.has_filename(path):
501
deleted_paths.add(path)
371
502
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)
503
deleted_ids.append(ie.file_id)
504
self.work_tree.unversion(deleted_ids)
402
506
def _populate_new_inv(self):
403
507
"""Build revision inventory.
409
513
None; inventory entries that are carried over untouched have their
410
514
revision set to their prior value.
516
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
517
# results to create a new inventory at the same time, which results
518
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
412
520
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():
521
entries = self.work_inv.iter_entries()
522
if not self.builder.record_root_entry:
523
symbol_versioning.warn('CommitBuilders should support recording'
524
' the root entry as of bzr 0.10.', DeprecationWarning,
526
self.builder.new_inventory.add(self.basis_inv.root.copy())
528
self._emit_progress_update()
529
for path, new_ie in entries:
530
self._emit_progress_update()
415
531
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)
532
# mutter('check %s {%s}', path, file_id)
533
if (not self.specific_files or
534
is_inside_or_parent_of_any(self.specific_files, path)):
535
# mutter('%s selected for commit', path)
539
# mutter('%s not selected for commit', path)
540
if self.basis_inv.has_id(file_id):
541
ie = self.basis_inv[file_id].copy()
543
# 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())
546
self.builder.record_entry_contents(ie, self.parent_invs,
547
path, self.work_tree)
548
# describe the nature of the change that has occurred relative to
549
# the basis inventory.
550
if (self.basis_inv.has_id(ie.file_id)):
551
basis_ie = self.basis_inv[ie.file_id]
554
change = ie.describe_change(basis_ie, ie)
555
if change in (InventoryEntry.RENAMED,
556
InventoryEntry.MODIFIED_AND_RENAMED):
557
old_path = self.basis_inv.id2path(ie.file_id)
558
self.reporter.renamed(change, old_path, path)
560
self.reporter.snapshot_change(change, path)
562
if not self.specific_files:
565
# ignore removals that don't match filespec
566
for path, new_ie in self.basis_inv.iter_entries():
567
if new_ie.file_id in self.work_inv:
569
if is_inside_any(self.specific_files, path):
573
self.builder.record_entry_contents(ie, self.parent_invs, path,
576
def _emit_progress_update(self):
577
"""Emit an update to the progress bar."""
578
self.pb.update("Committing", self.pb_count, self.pb_total)
452
581
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))
582
for path, ie in self.basis_inv.iter_entries():
583
if ie.file_id not in self.builder.new_inventory:
584
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
