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 = revprops
209
if strict and branch.unknowns():
210
raise StrictCommitFailed()
212
if timestamp is None:
213
self.timestamp = time.time()
215
self.timestamp = long(timestamp)
217
if self.config is None:
218
self.config = bzrlib.config.BranchConfig(self.branch)
221
self.rev_id = _gen_revision_id(self.config, self.timestamp)
225
if committer is None:
226
self.committer = self.config.username()
228
assert isinstance(committer, basestring), type(committer)
229
self.committer = committer
232
self.timezone = local_time_offset()
234
self.timezone = int(timezone)
236
assert isinstance(message, basestring), type(message)
237
self.message = message
238
self._escape_commit_message()
240
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()
242
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()
243
280
self.work_inv = self.work_tree.inventory
244
self.basis_tree = self.branch.basis_tree()
281
self.basis_tree = self.work_tree.basis_tree()
245
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
247
296
self._gather_parents()
248
297
if len(self.parents) > 1 and self.specific_files:
249
raise NotImplementedError('selected-file commit of merges is not supported yet')
250
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)
252
304
self._remove_deleted()
253
305
self._populate_new_inv()
254
self._store_snapshot()
255
306
self._report_deletes()
257
if not (self.allow_pointless
258
or len(self.parents) > 1
259
or self.new_inv != self.basis_inv):
260
raise PointlessCommit()
262
if len(list(self.work_tree.iter_conflicts()))>0:
263
raise ConflictsInTree
265
self._record_inventory()
266
self._make_revision()
267
self.reporter.completed(self.branch.revno()+1, self.rev_id)
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.
268
333
self.branch.append_revision(self.rev_id)
269
self.branch.set_pending_merges([])
335
rev_tree = self.builder.revision_tree()
336
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
337
# now the work tree is up to date with the branch
339
self.reporter.completed(self.branch.revno(), self.rev_id)
340
if self.config.post_commit() is not None:
341
hooks = self.config.post_commit().split(' ')
342
# this would be nicer with twisted.python.reflect.namedAny
344
result = eval(hook + '(branch, rev_id)',
345
{'branch':self.branch,
347
'rev_id':self.rev_id})
348
self._emit_progress_update()
273
def _record_inventory(self):
274
"""Store the inventory for the new revision."""
275
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
276
self.inv_sha1 = sha_string(inv_text)
277
s = self.branch.control_weaves
278
s.add_text('inventory', self.rev_id,
279
split_lines(inv_text), self.present_parents,
280
self.branch.get_transaction())
353
def _any_real_changes(self):
354
"""Are there real changes between new_inventory and basis?
356
For trees without rich roots, inv.root.revision changes every commit.
357
But if that is the only change, we want to treat it as though there
360
new_entries = self.builder.new_inventory.iter_entries()
361
basis_entries = self.basis_inv.iter_entries()
362
new_path, new_root_ie = new_entries.next()
363
basis_path, basis_root_ie = basis_entries.next()
365
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
366
def ie_equal_no_revision(this, other):
367
return ((this.file_id == other.file_id)
368
and (this.name == other.name)
369
and (this.symlink_target == other.symlink_target)
370
and (this.text_sha1 == other.text_sha1)
371
and (this.text_size == other.text_size)
372
and (this.text_id == other.text_id)
373
and (this.parent_id == other.parent_id)
374
and (this.kind == other.kind)
375
and (this.executable == other.executable)
377
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
380
for new_ie, basis_ie in zip(new_entries, basis_entries):
381
if new_ie != basis_ie:
384
# No actual changes present
387
def _check_pointless(self):
388
if self.allow_pointless:
390
# A merge with no effect on files
391
if len(self.parents) > 1:
393
# Shortcut, if the number of entries changes, then we obviously have
395
if len(self.builder.new_inventory) != len(self.basis_inv):
397
# If length == 1, then we only have the root entry. Which means
398
# that there is no real difference (only the root could be different)
399
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
401
raise PointlessCommit()
403
def _check_bound_branch(self):
404
"""Check to see if the local branch is bound.
406
If it is bound, then most of the commit will actually be
407
done using the remote branch as the target branch.
408
Only at the end will the local branch be updated.
410
if self.local and not self.branch.get_bound_location():
411
raise errors.LocalRequiresBoundBranch()
414
self.master_branch = self.branch.get_master_branch()
416
if not self.master_branch:
417
# make this branch the reference branch for out of date checks.
418
self.master_branch = self.branch
421
# If the master branch is bound, we must fail
422
master_bound_location = self.master_branch.get_bound_location()
423
if master_bound_location:
424
raise errors.CommitToDoubleBoundBranch(self.branch,
425
self.master_branch, master_bound_location)
427
# TODO: jam 20051230 We could automatically push local
428
# commits to the remote branch if they would fit.
429
# But for now, just require remote to be identical
432
# Make sure the local branch is identical to the master
433
master_rh = self.master_branch.revision_history()
434
local_rh = self.branch.revision_history()
435
if local_rh != master_rh:
436
raise errors.BoundBranchOutOfDate(self.branch,
439
# Now things are ready to change the master branch
441
self.bound_branch = self.branch
442
self.master_branch.lock_write()
443
self.master_locked = True
446
"""Cleanup any open locks, progress bars etc."""
447
cleanups = [self._cleanup_bound_branch,
448
self.work_tree.unlock,
450
found_exception = None
451
for cleanup in cleanups:
454
# we want every cleanup to run no matter what.
455
# so we have a catchall here, but we will raise the
456
# last encountered exception up the stack: and
457
# typically this will be useful enough.
460
if found_exception is not None:
461
# don't do a plan raise, because the last exception may have been
462
# trashed, e is our sure-to-work exception even though it loses the
463
# full traceback. XXX: RBC 20060421 perhaps we could check the
464
# exc_info and if its the same one do a plain raise otherwise
465
# 'raise e' as we do now.
468
def _cleanup_bound_branch(self):
469
"""Executed at the end of a try/finally to cleanup a bound branch.
471
If the branch wasn't bound, this is a no-op.
472
If it was, it resents self.branch to the local branch, instead
475
if not self.bound_branch:
477
if self.master_locked:
478
self.master_branch.unlock()
282
480
def _escape_commit_message(self):
283
481
"""Replace xml-incompatible control characters."""
482
# FIXME: RBC 20060419 this should be done by the revision
483
# serialiser not by commit. Then we can also add an unescaper
484
# in the deserializer and start roundtripping revision messages
485
# precisely. See repository_implementations/test_repository.py
284
487
# Python strings can include characters that can't be
285
488
# represented in well-formed XML; escape characters that
286
489
# aren't listed in the XML specification
287
490
# (http://www.w3.org/TR/REC-xml/#NT-Char).
288
if isinstance(self.message, unicode):
289
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
291
# Use a regular 'str' as pattern to avoid having re.subn
292
# return 'unicode' results.
293
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
294
491
self.message, escape_count = re.subn(
492
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
296
493
lambda match: match.group(0).encode('unicode_escape'),
301
498
def _gather_parents(self):
302
499
"""Record the parents of a merge for merge detection."""
303
pending_merges = self.branch.pending_merges()
500
# TODO: Make sure that this list doesn't contain duplicate
501
# entries and the order is preserved when doing this.
502
self.parents = self.work_tree.get_parent_ids()
305
503
self.parent_invs = []
306
self.present_parents = []
307
precursor_id = self.branch.last_revision()
309
self.parents.append(precursor_id)
310
self.parents += pending_merges
311
504
for revision in self.parents:
312
if self.branch.has_revision(revision):
313
self.parent_invs.append(self.branch.get_inventory(revision))
314
self.present_parents.append(revision)
316
def _check_parents_present(self):
317
for parent_id in self.parents:
318
mutter('commit parent revision {%s}', parent_id)
319
if not self.branch.has_revision(parent_id):
320
if parent_id == self.branch.last_revision():
321
warning("parent is missing %r", parent_id)
322
raise HistoryMissing(self.branch, 'revision', parent_id)
324
mutter("commit will ghost revision %r", parent_id)
326
def _make_revision(self):
327
"""Record a new revision object for this commit."""
328
self.rev = Revision(timestamp=self.timestamp,
329
timezone=self.timezone,
330
committer=self.committer,
331
message=self.message,
332
inventory_sha1=self.inv_sha1,
333
revision_id=self.rev_id,
334
properties=self.revprops)
335
self.rev.parent_ids = self.parents
337
serializer_v5.write_revision(self.rev, rev_tmp)
339
if self.config.signature_needed():
340
plaintext = Testament(self.rev, self.new_inv).as_short_text()
341
self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
342
plaintext, self.rev_id)
343
self.branch.revision_store.add(rev_tmp, self.rev_id)
344
mutter('new revision_id is {%s}', self.rev_id)
505
if self.branch.repository.has_revision(revision):
506
mutter('commit parent revision {%s}', revision)
507
inventory = self.branch.repository.get_inventory(revision)
508
self.parent_invs.append(inventory)
510
mutter('commit parent ghost revision {%s}', revision)
346
512
def _remove_deleted(self):
347
513
"""Remove deleted files from the working inventories.
401
545
None; inventory entries that are carried over untouched have their
402
546
revision set to their prior value.
548
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
549
# results to create a new inventory at the same time, which results
550
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
404
552
mutter("Selecting files for commit with filter %s", self.specific_files)
405
self.new_inv = Inventory()
406
for path, new_ie in self.work_inv.iter_entries():
553
entries = self.work_inv.iter_entries()
554
if not self.builder.record_root_entry:
555
symbol_versioning.warn('CommitBuilders should support recording'
556
' the root entry as of bzr 0.10.', DeprecationWarning,
558
self.builder.new_inventory.add(self.basis_inv.root.copy())
560
self._emit_progress_update()
561
for path, new_ie in entries:
562
self._emit_progress_update()
407
563
file_id = new_ie.file_id
408
mutter('check %s {%s}', path, new_ie.file_id)
409
if self.specific_files:
410
if not is_inside_any(self.specific_files, path):
411
mutter('%s not selected for commit', path)
412
self._carry_entry(file_id)
564
# mutter('check %s {%s}', path, file_id)
565
if (not self.specific_files or
566
is_inside_or_parent_of_any(self.specific_files, path)):
567
# mutter('%s selected for commit', path)
571
# mutter('%s not selected for commit', path)
572
if self.basis_inv.has_id(file_id):
573
ie = self.basis_inv[file_id].copy()
575
# this entry is new and not being committed
415
# this is selected, ensure its parents are too.
416
parent_id = new_ie.parent_id
417
while parent_id != ROOT_ID:
418
if not self.new_inv.has_id(parent_id):
419
ie = self._select_entry(self.work_inv[parent_id])
420
mutter('%s selected for commit because of %s',
421
self.new_inv.id2path(parent_id), path)
423
ie = self.new_inv[parent_id]
424
if ie.revision is not None:
426
mutter('%s selected for commit because of %s',
427
self.new_inv.id2path(parent_id), path)
428
parent_id = ie.parent_id
429
mutter('%s selected for commit', path)
430
self._select_entry(new_ie)
432
def _select_entry(self, new_ie):
433
"""Make new_ie be considered for committing."""
439
def _carry_entry(self, file_id):
440
"""Carry the file unchanged from the basis revision."""
441
if self.basis_inv.has_id(file_id):
442
self.new_inv.add(self.basis_inv[file_id].copy())
578
self.builder.record_entry_contents(ie, self.parent_invs,
579
path, self.work_tree)
580
# describe the nature of the change that has occurred relative to
581
# the basis inventory.
582
if (self.basis_inv.has_id(ie.file_id)):
583
basis_ie = self.basis_inv[ie.file_id]
586
change = ie.describe_change(basis_ie, ie)
587
if change in (InventoryEntry.RENAMED,
588
InventoryEntry.MODIFIED_AND_RENAMED):
589
old_path = self.basis_inv.id2path(ie.file_id)
590
self.reporter.renamed(change, old_path, path)
592
self.reporter.snapshot_change(change, path)
594
if not self.specific_files:
597
# ignore removals that don't match filespec
598
for path, new_ie in self.basis_inv.iter_entries():
599
if new_ie.file_id in self.work_inv:
601
if is_inside_any(self.specific_files, path):
605
self.builder.record_entry_contents(ie, self.parent_invs, path,
608
def _emit_progress_update(self):
609
"""Emit an update to the progress bar."""
610
self.pb.update("Committing", self.pb_count, self.pb_total)
444
613
def _report_deletes(self):
445
for file_id in self.basis_inv:
446
if file_id not in self.new_inv:
447
self.reporter.deleted(self.basis_inv.id2path(file_id))
449
def _gen_revision_id(config, when):
450
"""Return new revision-id."""
451
s = '%s-%s-' % (config.user_email(), compact_date(when))
452
s += hexlify(rand_bytes(8))
614
for path, ie in self.basis_inv.iter_entries():
615
if ie.file_id not in self.builder.new_inventory:
616
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
