56
55
# merges from, then it should still be reported as newly added
57
56
# relative to the basis revision.
58
# TODO: Do checks that the tree can be committed *before* running the
59
# editor; this should include checks for a pointless commit and for
60
# unknown or missing files.
62
# TODO: If commit fails, leave the message in a file somewhere.
66
from binascii import hexlify
67
70
from cStringIO import StringIO
69
from bzrlib.osutils import (local_time_offset, username,
70
rand_bytes, compact_date, user_email,
71
kind_marker, is_inside_any, quotefn,
72
sha_string, sha_strings, sha_file, isdir, isfile,
74
from bzrlib.branch import gen_file_id
73
import bzrlib.errors as errors
75
74
from bzrlib.errors import (BzrError, PointlessCommit,
79
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)
81
from bzrlib.testament import Testament
80
82
from bzrlib.trace import mutter, note, warning
81
83
from bzrlib.xml5 import serializer_v5
82
from bzrlib.inventory import Inventory, ROOT_ID
83
from bzrlib.weave import Weave
84
from bzrlib.weavefile import read_weave, write_weave_v5
85
from bzrlib.atomicfile import AtomicFile
88
def commit(*args, **kwargs):
89
"""Commit a new revision to a branch.
91
Function-style interface for convenience of old callers.
93
New code should use the Commit class instead.
95
## XXX: Remove this in favor of Branch.commit?
96
Commit().commit(*args, **kwargs)
84
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
85
from bzrlib import symbol_versioning
86
from bzrlib.symbol_versioning import (deprecated_passed,
89
from bzrlib.workingtree import WorkingTree
99
92
class NullCommitReporter(object):
176
199
allow_pointless -- If true (default), commit even if nothing
177
200
has changed and no merges are recorded.
202
strict -- If true, don't allow a commit if the working tree
203
contains unknown files.
205
revprops -- Properties for new revision
206
:param local: Perform a local only commit.
179
208
mutter('preparing to commit')
182
self.weave_store = branch.weave_store
210
if deprecated_passed(branch):
211
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
212
"deprecated as of bzr 0.8. Please use working_tree= instead.",
213
DeprecationWarning, stacklevel=2)
215
self.work_tree = self.branch.bzrdir.open_workingtree()
216
elif working_tree is None:
217
raise BzrError("One of branch and working_tree must be passed into commit().")
219
self.work_tree = working_tree
220
self.branch = self.work_tree.branch
222
raise BzrError("The message keyword parameter is required for commit().")
224
self.bound_branch = None
226
self.master_branch = None
227
self.master_locked = False
184
229
self.specific_files = specific_files
185
230
self.allow_pointless = allow_pointless
187
if timestamp is None:
188
self.timestamp = time.time()
190
self.timestamp = long(timestamp)
193
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
197
if committer is None:
198
self.committer = username(self.branch)
200
assert isinstance(committer, basestring), type(committer)
201
self.committer = committer
204
self.timezone = local_time_offset()
206
self.timezone = int(timezone)
208
assert isinstance(message, basestring), type(message)
209
self.message = message
210
self._escape_commit_message()
212
self.branch.lock_write()
232
if reporter is None and self.reporter is None:
233
self.reporter = NullCommitReporter()
234
elif reporter is not None:
235
self.reporter = reporter
237
self.work_tree.lock_write()
238
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
214
self.work_tree = self.branch.working_tree()
240
# Cannot commit with conflicts present.
241
if len(self.work_tree.conflicts())>0:
242
raise ConflictsInTree
244
# setup the bound branch variables as needed.
245
self._check_bound_branch()
247
# check for out of date working trees
248
# if we are bound, then self.branch is the master branch and this
249
# test is thus all we need.
250
if self.work_tree.last_revision() != self.master_branch.last_revision():
251
raise errors.OutOfDateTree(self.work_tree)
254
# raise an exception as soon as we find a single unknown.
255
for unknown in self.work_tree.unknowns():
256
raise StrictCommitFailed()
258
if self.config is None:
259
self.config = self.branch.get_config()
261
if isinstance(message, str):
262
message = message.decode(bzrlib.user_encoding)
263
assert isinstance(message, unicode), type(message)
264
self.message = message
265
self._escape_commit_message()
215
267
self.work_inv = self.work_tree.inventory
216
self.basis_tree = self.branch.basis_tree()
268
self.basis_tree = self.work_tree.basis_tree()
217
269
self.basis_inv = self.basis_tree.inventory
270
# one to finish, one for rev and inventory, and one for each
271
# inventory entry, and the same for the new inventory.
272
# note that this estimate is too long when we do a partial tree
273
# commit which excludes some new files from being considered.
274
# The estimate is corrected when we populate the new inv.
275
self.pb_total = len(self.work_inv) + 5
219
278
self._gather_parents()
220
279
if len(self.parents) > 1 and self.specific_files:
221
raise NotImplementedError('selected-file commit of merges is not supported yet')
280
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
222
282
self._check_parents_present()
283
self.builder = self.branch.get_commit_builder(self.parents,
284
self.config, timestamp, timezone, committer, revprops, rev_id)
224
286
self._remove_deleted()
225
287
self._populate_new_inv()
226
self._store_snapshot()
227
288
self._report_deletes()
229
290
if not (self.allow_pointless
230
291
or len(self.parents) > 1
231
or self.new_inv != self.basis_inv):
292
or self.builder.new_inventory != self.basis_inv):
232
293
raise PointlessCommit()
234
if len(list(self.work_tree.iter_conflicts()))>0:
235
raise ConflictsInTree
295
self._emit_progress_update()
296
# TODO: Now the new inventory is known, check for conflicts and
297
# prompt the user for a commit message.
298
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
299
# weave lines, because nothing should be recorded until it is known
300
# that commit will succeed.
301
self.builder.finish_inventory()
302
self._emit_progress_update()
303
self.rev_id = self.builder.commit(self.message)
304
self._emit_progress_update()
305
# revision data is in the local branch now.
307
# upload revision data to the master.
308
# this will propagate merged revisions too if needed.
309
if self.bound_branch:
310
self.master_branch.repository.fetch(self.branch.repository,
311
revision_id=self.rev_id)
312
# now the master has the revision data
313
# 'commit' to the master first so a timeout here causes the local
314
# branch to be out of date
315
self.master_branch.append_revision(self.rev_id)
237
self._record_inventory()
238
self._make_revision()
239
self.reporter.completed(self.branch.revno()+1, self.rev_id)
317
# and now do the commit locally.
240
318
self.branch.append_revision(self.rev_id)
241
self.branch.set_pending_merges([])
320
self.work_tree.set_pending_merges([])
321
self.work_tree.set_last_revision(self.rev_id)
322
# now the work tree is up to date with the branch
324
self.reporter.completed(self.branch.revno(), self.rev_id)
325
if self.config.post_commit() is not None:
326
hooks = self.config.post_commit().split(' ')
327
# this would be nicer with twisted.python.reflect.namedAny
329
result = eval(hook + '(branch, rev_id)',
330
{'branch':self.branch,
332
'rev_id':self.rev_id})
333
self._emit_progress_update()
245
def _record_inventory(self):
246
"""Store the inventory for the new revision."""
247
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
248
self.inv_sha1 = sha_string(inv_text)
249
s = self.branch.control_weaves
250
s.add_text('inventory', self.rev_id,
251
split_lines(inv_text), self.present_parents)
338
def _check_bound_branch(self):
339
"""Check to see if the local branch is bound.
341
If it is bound, then most of the commit will actually be
342
done using the remote branch as the target branch.
343
Only at the end will the local branch be updated.
345
if self.local and not self.branch.get_bound_location():
346
raise errors.LocalRequiresBoundBranch()
349
self.master_branch = self.branch.get_master_branch()
351
if not self.master_branch:
352
# make this branch the reference branch for out of date checks.
353
self.master_branch = self.branch
356
# If the master branch is bound, we must fail
357
master_bound_location = self.master_branch.get_bound_location()
358
if master_bound_location:
359
raise errors.CommitToDoubleBoundBranch(self.branch,
360
self.master_branch, master_bound_location)
362
# TODO: jam 20051230 We could automatically push local
363
# commits to the remote branch if they would fit.
364
# But for now, just require remote to be identical
367
# Make sure the local branch is identical to the master
368
master_rh = self.master_branch.revision_history()
369
local_rh = self.branch.revision_history()
370
if local_rh != master_rh:
371
raise errors.BoundBranchOutOfDate(self.branch,
374
# Now things are ready to change the master branch
376
self.bound_branch = self.branch
377
self.master_branch.lock_write()
378
self.master_locked = True
381
"""Cleanup any open locks, progress bars etc."""
382
cleanups = [self._cleanup_bound_branch,
383
self.work_tree.unlock,
385
found_exception = None
386
for cleanup in cleanups:
389
# we want every cleanup to run no matter what.
390
# so we have a catchall here, but we will raise the
391
# last encountered exception up the stack: and
392
# typically this will be useful enough.
395
if found_exception is not None:
396
# don't do a plan raise, because the last exception may have been
397
# trashed, e is our sure-to-work exception even though it loses the
398
# full traceback. XXX: RBC 20060421 perhaps we could check the
399
# exc_info and if its the same one do a plain raise otherwise
400
# 'raise e' as we do now.
403
def _cleanup_bound_branch(self):
404
"""Executed at the end of a try/finally to cleanup a bound branch.
406
If the branch wasn't bound, this is a no-op.
407
If it was, it resents self.branch to the local branch, instead
410
if not self.bound_branch:
412
if self.master_locked:
413
self.master_branch.unlock()
253
415
def _escape_commit_message(self):
254
416
"""Replace xml-incompatible control characters."""
417
# FIXME: RBC 20060419 this should be done by the revision
418
# serialiser not by commit. Then we can also add an unescaper
419
# in the deserializer and start roundtripping revision messages
420
# precisely. See repository_implementations/test_repository.py
255
422
# Python strings can include characters that can't be
256
423
# represented in well-formed XML; escape characters that
257
424
# aren't listed in the XML specification
258
425
# (http://www.w3.org/TR/REC-xml/#NT-Char).
259
if isinstance(self.message, unicode):
260
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
262
# Use a regular 'str' as pattern to avoid having re.subn
263
# return 'unicode' results.
264
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
265
426
self.message, escape_count = re.subn(
427
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
267
428
lambda match: match.group(0).encode('unicode_escape'),
272
433
def _gather_parents(self):
273
434
"""Record the parents of a merge for merge detection."""
274
pending_merges = self.branch.pending_merges()
435
# TODO: Make sure that this list doesn't contain duplicate
436
# entries and the order is preserved when doing this.
437
self.parents = self.work_tree.get_parent_ids()
276
438
self.parent_invs = []
277
self.present_parents = []
278
precursor_id = self.branch.last_revision()
280
self.parents.append(precursor_id)
281
self.parents += pending_merges
282
439
for revision in self.parents:
283
if self.branch.has_revision(revision):
284
self.parent_invs.append(self.branch.get_inventory(revision))
285
self.present_parents.append(revision)
440
if self.branch.repository.has_revision(revision):
441
inventory = self.branch.repository.get_inventory(revision)
442
self.parent_invs.append(inventory)
287
444
def _check_parents_present(self):
288
445
for parent_id in self.parents:
289
446
mutter('commit parent revision {%s}', parent_id)
290
if not self.branch.has_revision(parent_id):
447
if not self.branch.repository.has_revision(parent_id):
291
448
if parent_id == self.branch.last_revision():
292
449
warning("parent is missing %r", parent_id)
293
raise HistoryMissing(self.branch, 'revision', parent_id)
295
mutter("commit will ghost revision %r", parent_id)
450
raise BzrCheckError("branch %s is missing revision {%s}"
451
% (self.branch, parent_id))
297
def _make_revision(self):
298
"""Record a new revision object for this commit."""
299
self.rev = Revision(timestamp=self.timestamp,
300
timezone=self.timezone,
301
committer=self.committer,
302
message=self.message,
303
inventory_sha1=self.inv_sha1,
304
revision_id=self.rev_id)
305
self.rev.parent_ids = self.parents
307
serializer_v5.write_revision(self.rev, rev_tmp)
309
self.branch.revision_store.add(rev_tmp, self.rev_id)
310
mutter('new revision_id is {%s}', self.rev_id)
312
453
def _remove_deleted(self):
313
454
"""Remove deleted files from the working inventories.
365
485
None; inventory entries that are carried over untouched have their
366
486
revision set to their prior value.
488
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
489
# results to create a new inventory at the same time, which results
490
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
368
492
mutter("Selecting files for commit with filter %s", self.specific_files)
369
self.new_inv = Inventory()
370
for path, new_ie in self.work_inv.iter_entries():
493
entries = self.work_inv.iter_entries()
494
if not self.builder.record_root_entry:
495
symbol_versioning.warn('CommitBuilders should support recording'
496
' the root entry as of bzr 0.10.', DeprecationWarning,
498
self.builder.new_inventory.add(self.basis_inv.root.copy())
500
self._emit_progress_update()
501
for path, new_ie in entries:
502
self._emit_progress_update()
371
503
file_id = new_ie.file_id
372
mutter('check %s {%s}', path, new_ie.file_id)
373
if self.specific_files:
374
if not is_inside_any(self.specific_files, path):
375
mutter('%s not selected for commit', path)
376
self._carry_entry(file_id)
504
# mutter('check %s {%s}', path, file_id)
505
if (not self.specific_files or
506
is_inside_or_parent_of_any(self.specific_files, path)):
507
# mutter('%s selected for commit', path)
511
# mutter('%s not selected for commit', path)
512
if self.basis_inv.has_id(file_id):
513
ie = self.basis_inv[file_id].copy()
515
# this entry is new and not being committed
379
# this is selected, ensure its parents are too.
380
parent_id = new_ie.parent_id
381
while parent_id != ROOT_ID:
382
if not self.new_inv.has_id(parent_id):
383
ie = self._select_entry(self.work_inv[parent_id])
384
mutter('%s selected for commit because of %s',
385
self.new_inv.id2path(parent_id), path)
387
ie = self.new_inv[parent_id]
388
if ie.revision is not None:
390
mutter('%s selected for commit because of %s',
391
self.new_inv.id2path(parent_id), path)
392
parent_id = ie.parent_id
393
mutter('%s selected for commit', path)
394
self._select_entry(new_ie)
396
def _select_entry(self, new_ie):
397
"""Make new_ie be considered for committing."""
403
def _carry_entry(self, file_id):
404
"""Carry the file unchanged from the basis revision."""
405
if self.basis_inv.has_id(file_id):
406
self.new_inv.add(self.basis_inv[file_id].copy())
518
self.builder.record_entry_contents(ie, self.parent_invs,
519
path, self.work_tree)
520
# describe the nature of the change that has occurred relative to
521
# the basis inventory.
522
if (self.basis_inv.has_id(ie.file_id)):
523
basis_ie = self.basis_inv[ie.file_id]
526
change = ie.describe_change(basis_ie, ie)
527
if change in (InventoryEntry.RENAMED,
528
InventoryEntry.MODIFIED_AND_RENAMED):
529
old_path = self.basis_inv.id2path(ie.file_id)
530
self.reporter.renamed(change, old_path, path)
532
self.reporter.snapshot_change(change, path)
534
if not self.specific_files:
537
# ignore removals that don't match filespec
538
for path, new_ie in self.basis_inv.iter_entries():
539
if new_ie.file_id in self.work_inv:
541
if is_inside_any(self.specific_files, path):
545
self.builder.record_entry_contents(ie, self.parent_invs, path,
548
def _emit_progress_update(self):
549
"""Emit an update to the progress bar."""
550
self.pb.update("Committing", self.pb_count, self.pb_total)
408
553
def _report_deletes(self):
409
for file_id in self.basis_inv:
410
if file_id not in self.new_inv:
411
self.reporter.deleted(self.basis_inv.id2path(file_id))
413
def _gen_revision_id(branch, when):
414
"""Return new revision-id."""
415
s = '%s-%s-' % (user_email(branch), compact_date(when))
416
s += hexlify(rand_bytes(8))
554
for path, ie in self.basis_inv.iter_entries():
555
if ie.file_id not in self.builder.new_inventory:
556
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
