72
from binascii import hexlify
70
73
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_string, sha_strings, sha_file, isdir, isfile,
72
81
import bzrlib.config
73
import bzrlib.errors as errors
74
82
from bzrlib.errors import (BzrError, PointlessCommit,
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)
87
import bzrlib.gpg as gpg
88
from bzrlib.revision import Revision
81
89
from bzrlib.testament import Testament
82
90
from bzrlib.trace import mutter, note, warning
83
91
from bzrlib.xml5 import serializer_v5
84
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
85
from bzrlib import symbol_versioning
86
from bzrlib.symbol_versioning import (deprecated_passed,
92
from bzrlib.inventory import Inventory, ROOT_ID
93
from bzrlib.weave import Weave
94
from bzrlib.weavefile import read_weave, write_weave_v5
89
95
from bzrlib.workingtree import WorkingTree
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)
92
109
class NullCommitReporter(object):
93
110
"""I report on progress of a commit."""
107
124
def missing(self, path):
110
def renamed(self, change, old_path, new_path):
114
128
class ReportCommitToLog(NullCommitReporter):
116
# this may be more useful if 'note' was replaced by an overridable
117
# method on self, which would allow more trivial subclassing.
118
# alternative, a callable could be passed in, allowing really trivial
119
# reuse for some uis. RBC 20060511
121
130
def snapshot_change(self, change, path):
122
if change == 'unchanged':
124
131
note("%s %s", change, path)
126
133
def completed(self, revno, rev_id):
127
note('Committed revision %d.', revno)
134
note('committed r%d {%s}', revno, rev_id)
129
136
def deleted(self, file_id):
130
137
note('deleted %s', file_id)
203
198
contains unknown files.
205
200
revprops -- Properties for new revision
206
:param local: Perform a local only commit.
208
202
mutter('preparing to commit')
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
205
self.weave_store = branch.weave_store
229
207
self.specific_files = specific_files
230
208
self.allow_pointless = allow_pointless
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()
209
self.revprops = {'branch-nick': branch.nick}
211
self.revprops.update(revprops)
212
self.work_tree = WorkingTree(branch.base, branch)
215
# raise an exception as soon as we find a single unknown.
216
for unknown in self.work_tree.unknowns():
217
raise StrictCommitFailed()
219
if timestamp is None:
220
self.timestamp = time.time()
222
self.timestamp = long(timestamp)
224
if self.config is None:
225
self.config = bzrlib.config.BranchConfig(self.branch)
228
self.rev_id = _gen_revision_id(self.config, self.timestamp)
232
if committer is None:
233
self.committer = self.config.username()
235
assert isinstance(committer, basestring), type(committer)
236
self.committer = committer
239
self.timezone = local_time_offset()
241
self.timezone = int(timezone)
243
if isinstance(message, str):
244
message = message.decode(bzrlib.user_encoding)
245
assert isinstance(message, unicode), type(message)
246
self.message = message
247
self._escape_commit_message()
249
self.branch.lock_write()
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()
267
251
self.work_inv = self.work_tree.inventory
268
self.basis_tree = self.work_tree.basis_tree()
252
self.basis_tree = self.branch.basis_tree()
269
253
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
278
255
self._gather_parents()
279
256
if len(self.parents) > 1 and self.specific_files:
280
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
257
raise NotImplementedError('selected-file commit of merges is not supported yet')
282
258
self._check_parents_present()
283
self.builder = self.branch.get_commit_builder(self.parents,
284
self.config, timestamp, timezone, committer, revprops, rev_id)
286
260
self._remove_deleted()
287
261
self._populate_new_inv()
262
self._store_snapshot()
288
263
self._report_deletes()
290
265
if not (self.allow_pointless
291
266
or len(self.parents) > 1
292
or self.builder.new_inventory != self.basis_inv):
267
or self.new_inv != self.basis_inv):
293
268
raise PointlessCommit()
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)
270
if len(list(self.work_tree.iter_conflicts()))>0:
271
raise ConflictsInTree
317
# and now do the commit locally.
273
self._record_inventory()
274
self._make_revision()
275
self.work_tree.set_pending_merges([])
318
276
self.branch.append_revision(self.rev_id)
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)
277
self.reporter.completed(self.branch.revno()+1, self.rev_id)
325
278
if self.config.post_commit() is not None:
326
279
hooks = self.config.post_commit().split(' ')
327
280
# this would be nicer with twisted.python.reflect.namedAny
330
283
{'branch':self.branch,
332
285
'rev_id':self.rev_id})
333
self._emit_progress_update()
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()
289
def _record_inventory(self):
290
"""Store the inventory for the new revision."""
291
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
292
self.inv_sha1 = sha_string(inv_text)
293
s = self.branch.control_weaves
294
s.add_text('inventory', self.rev_id,
295
split_lines(inv_text), self.present_parents,
296
self.branch.get_transaction())
415
298
def _escape_commit_message(self):
416
299
"""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
422
300
# Python strings can include characters that can't be
423
301
# represented in well-formed XML; escape characters that
424
302
# aren't listed in the XML specification
433
311
def _gather_parents(self):
434
312
"""Record the parents of a merge for merge detection."""
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()
313
pending_merges = self.work_tree.pending_merges()
438
315
self.parent_invs = []
316
self.present_parents = []
317
precursor_id = self.branch.last_revision()
319
self.parents.append(precursor_id)
320
self.parents += pending_merges
439
321
for revision in self.parents:
440
if self.branch.repository.has_revision(revision):
441
inventory = self.branch.repository.get_inventory(revision)
442
self.parent_invs.append(inventory)
322
if self.branch.has_revision(revision):
323
self.parent_invs.append(self.branch.get_inventory(revision))
324
self.present_parents.append(revision)
444
326
def _check_parents_present(self):
445
327
for parent_id in self.parents:
446
328
mutter('commit parent revision {%s}', parent_id)
447
if not self.branch.repository.has_revision(parent_id):
329
if not self.branch.has_revision(parent_id):
448
330
if parent_id == self.branch.last_revision():
449
331
warning("parent is missing %r", parent_id)
450
raise BzrCheckError("branch %s is missing revision {%s}"
451
% (self.branch, parent_id))
332
raise HistoryMissing(self.branch, 'revision', parent_id)
334
mutter("commit will ghost revision %r", parent_id)
336
def _make_revision(self):
337
"""Record a new revision object for this commit."""
338
self.rev = Revision(timestamp=self.timestamp,
339
timezone=self.timezone,
340
committer=self.committer,
341
message=self.message,
342
inventory_sha1=self.inv_sha1,
343
revision_id=self.rev_id,
344
properties=self.revprops)
345
self.rev.parent_ids = self.parents
347
serializer_v5.write_revision(self.rev, rev_tmp)
349
if self.config.signature_needed():
350
plaintext = Testament(self.rev, self.new_inv).as_short_text()
351
self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
352
plaintext, self.rev_id)
353
self.branch.revision_store.add(rev_tmp, self.rev_id)
354
mutter('new revision_id is {%s}', self.rev_id)
453
356
def _remove_deleted(self):
454
357
"""Remove deleted files from the working inventories.
475
378
del self.work_inv[file_id]
476
379
self.work_tree._write_inventory(self.work_inv)
381
def _store_snapshot(self):
382
"""Pass over inventory and record a snapshot.
384
Entries get a new revision when they are modified in
385
any way, which includes a merge with a new set of
386
parents that have the same entry.
388
# XXX: Need to think more here about when the user has
389
# made a specific decision on a particular value -- c.f.
391
for path, ie in self.new_inv.iter_entries():
392
previous_entries = ie.find_previous_heads(
394
self.weave_store.get_weave_prelude_or_empty(ie.file_id,
395
self.branch.get_transaction()))
396
if ie.revision is None:
397
change = ie.snapshot(self.rev_id, path, previous_entries,
398
self.work_tree, self.weave_store,
399
self.branch.get_transaction())
402
self.reporter.snapshot_change(change, path)
478
404
def _populate_new_inv(self):
479
405
"""Build revision inventory.
485
411
None; inventory entries that are carried over untouched have their
486
412
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?
492
414
mutter("Selecting files for commit with filter %s", self.specific_files)
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()
415
self.new_inv = Inventory()
416
for path, new_ie in self.work_inv.iter_entries():
503
417
file_id = new_ie.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
418
mutter('check %s {%s}', path, new_ie.file_id)
419
if self.specific_files:
420
if not is_inside_any(self.specific_files, path):
421
mutter('%s not selected for commit', path)
422
self._carry_entry(file_id)
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)
425
# this is selected, ensure its parents are too.
426
parent_id = new_ie.parent_id
427
while parent_id != ROOT_ID:
428
if not self.new_inv.has_id(parent_id):
429
ie = self._select_entry(self.work_inv[parent_id])
430
mutter('%s selected for commit because of %s',
431
self.new_inv.id2path(parent_id), path)
433
ie = self.new_inv[parent_id]
434
if ie.revision is not None:
436
mutter('%s selected for commit because of %s',
437
self.new_inv.id2path(parent_id), path)
438
parent_id = ie.parent_id
439
mutter('%s selected for commit', path)
440
self._select_entry(new_ie)
442
def _select_entry(self, new_ie):
443
"""Make new_ie be considered for committing."""
449
def _carry_entry(self, file_id):
450
"""Carry the file unchanged from the basis revision."""
451
if self.basis_inv.has_id(file_id):
452
self.new_inv.add(self.basis_inv[file_id].copy())
553
454
def _report_deletes(self):
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)
455
for file_id in self.basis_inv:
456
if file_id not in self.new_inv:
457
self.reporter.deleted(self.basis_inv.id2path(file_id))
459
def _gen_revision_id(config, when):
460
"""Return new revision-id."""
461
s = '%s-%s-' % (config.user_email(), compact_date(when))
462
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
