72
from binascii import hexlify
72
73
from cStringIO import StringIO
74
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,
75
81
import bzrlib.config
76
import bzrlib.errors as errors
77
82
from bzrlib.errors import (BzrError, PointlessCommit,
82
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
83
is_inside_or_parent_of_any,
84
quotefn, sha_file, split_lines)
87
import bzrlib.gpg as gpg
88
from bzrlib.revision import Revision
85
89
from bzrlib.testament import Testament
86
90
from bzrlib.trace import mutter, note, warning
87
91
from bzrlib.xml5 import serializer_v5
88
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
92
from bzrlib.inventory import Inventory, ROOT_ID
89
93
from bzrlib.symbol_versioning import *
94
from bzrlib.weave import Weave
95
from bzrlib.weavefile import read_weave, write_weave_v5
90
96
from bzrlib.workingtree import WorkingTree
120
126
def missing(self, path):
123
def renamed(self, change, old_path, new_path):
127
130
class ReportCommitToLog(NullCommitReporter):
129
# this may be more useful if 'note' was replaced by an overridable
130
# method on self, which would allow more trivial subclassing.
131
# alternative, a callable could be passed in, allowing really trivial
132
# reuse for some uis. RBC 20060511
134
132
def snapshot_change(self, change, path):
135
if change == 'unchanged':
137
133
note("%s %s", change, path)
139
135
def completed(self, revno, rev_id):
140
note('Committed revision %d.', revno)
136
note('committed r%d {%s}', revno, rev_id)
142
138
def deleted(self, file_id):
143
139
note('deleted %s', file_id)
234
223
if message is None:
235
224
raise BzrError("The message keyword parameter is required for commit().")
237
self.bound_branch = None
239
self.master_branch = None
240
self.master_locked = False
226
self.weave_store = self.branch.repository.weave_store
242
228
self.specific_files = specific_files
243
229
self.allow_pointless = allow_pointless
245
if reporter is None and self.reporter is None:
246
self.reporter = NullCommitReporter()
247
elif reporter is not None:
248
self.reporter = reporter
250
self.work_tree.lock_write()
251
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
230
self.revprops = {'branch-nick': self.branch.nick}
232
self.revprops.update(revprops)
235
# raise an exception as soon as we find a single unknown.
236
for unknown in self.work_tree.unknowns():
237
raise StrictCommitFailed()
239
if timestamp is None:
240
self.timestamp = time.time()
242
self.timestamp = long(timestamp)
244
if self.config is None:
245
self.config = bzrlib.config.BranchConfig(self.branch)
248
self.rev_id = _gen_revision_id(self.config, self.timestamp)
252
if committer is None:
253
self.committer = self.config.username()
255
assert isinstance(committer, basestring), type(committer)
256
self.committer = committer
259
self.timezone = local_time_offset()
261
self.timezone = int(timezone)
263
if isinstance(message, str):
264
message = message.decode(bzrlib.user_encoding)
265
assert isinstance(message, unicode), type(message)
266
self.message = message
267
self._escape_commit_message()
269
self.branch.lock_write()
253
# Cannot commit with conflicts present.
254
if len(self.work_tree.conflicts())>0:
255
raise ConflictsInTree
257
# setup the bound branch variables as needed.
258
self._check_bound_branch()
260
# check for out of date working trees
261
# if we are bound, then self.branch is the master branch and this
262
# test is thus all we need.
263
if self.work_tree.last_revision() != self.master_branch.last_revision():
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 = bzrlib.config.BranchConfig(self.branch)
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()
280
271
self.work_inv = self.work_tree.inventory
281
self.basis_tree = self.work_tree.basis_tree()
272
self.basis_tree = self.branch.basis_tree()
282
273
self.basis_inv = self.basis_tree.inventory
283
# one to finish, one for rev and inventory, and one for each
284
# inventory entry, and the same for the new inventory.
285
# note that this estimate is too long when we do a partial tree
286
# commit which excludes some new files from being considered.
287
# The estimate is corrected when we populate the new inv.
288
self.pb_total = len(self.work_inv) + 5
291
275
self._gather_parents()
292
276
if len(self.parents) > 1 and self.specific_files:
293
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
277
raise NotImplementedError('selected-file commit of merges is not supported yet')
295
278
self._check_parents_present()
296
self.builder = self.branch.get_commit_builder(self.parents,
297
self.config, timestamp, timezone, committer, revprops, rev_id)
299
280
self._remove_deleted()
300
281
self._populate_new_inv()
282
self._store_snapshot()
301
283
self._report_deletes()
303
285
if not (self.allow_pointless
304
286
or len(self.parents) > 1
305
or self.builder.new_inventory != self.basis_inv):
287
or self.new_inv != self.basis_inv):
306
288
raise PointlessCommit()
308
self._emit_progress_update()
309
# TODO: Now the new inventory is known, check for conflicts and prompt the
310
# user for a commit message.
311
self.builder.finish_inventory()
312
self._emit_progress_update()
313
self.rev_id = self.builder.commit(self.message)
314
self._emit_progress_update()
315
# revision data is in the local branch now.
317
# upload revision data to the master.
318
# this will propagate merged revisions too if needed.
319
if self.bound_branch:
320
self.master_branch.repository.fetch(self.branch.repository,
321
revision_id=self.rev_id)
322
# now the master has the revision data
323
# 'commit' to the master first so a timeout here causes the local
324
# branch to be out of date
325
self.master_branch.append_revision(self.rev_id)
290
if len(list(self.work_tree.iter_conflicts()))>0:
291
raise ConflictsInTree
327
# and now do the commit locally.
293
self._record_inventory()
294
self._make_revision()
295
self.work_tree.set_pending_merges([])
328
296
self.branch.append_revision(self.rev_id)
330
self.work_tree.set_pending_merges([])
331
self.work_tree.set_last_revision(self.rev_id)
332
# now the work tree is up to date with the branch
334
self.reporter.completed(self.branch.revno(), self.rev_id)
297
if len(self.parents):
298
precursor = self.parents[0]
301
self.work_tree.set_last_revision(self.rev_id, precursor)
302
self.reporter.completed(self.branch.revno()+1, self.rev_id)
335
303
if self.config.post_commit() is not None:
336
304
hooks = self.config.post_commit().split(' ')
337
305
# this would be nicer with twisted.python.reflect.namedAny
340
308
{'branch':self.branch,
342
310
'rev_id':self.rev_id})
343
self._emit_progress_update()
347
def _check_bound_branch(self):
348
"""Check to see if the local branch is bound.
350
If it is bound, then most of the commit will actually be
351
done using the remote branch as the target branch.
352
Only at the end will the local branch be updated.
354
if self.local and not self.branch.get_bound_location():
355
raise errors.LocalRequiresBoundBranch()
358
self.master_branch = self.branch.get_master_branch()
360
if not self.master_branch:
361
# make this branch the reference branch for out of date checks.
362
self.master_branch = self.branch
365
# If the master branch is bound, we must fail
366
master_bound_location = self.master_branch.get_bound_location()
367
if master_bound_location:
368
raise errors.CommitToDoubleBoundBranch(self.branch,
369
self.master_branch, master_bound_location)
371
# TODO: jam 20051230 We could automatically push local
372
# commits to the remote branch if they would fit.
373
# But for now, just require remote to be identical
376
# Make sure the local branch is identical to the master
377
master_rh = self.master_branch.revision_history()
378
local_rh = self.branch.revision_history()
379
if local_rh != master_rh:
380
raise errors.BoundBranchOutOfDate(self.branch,
383
# Now things are ready to change the master branch
385
self.bound_branch = self.branch
386
self.master_branch.lock_write()
387
self.master_locked = True
389
#### # Check to see if we have any pending merges. If we do
390
#### # those need to be pushed into the master branch
391
#### pending_merges = self.work_tree.pending_merges()
392
#### if pending_merges:
393
#### for revision_id in pending_merges:
394
#### self.master_branch.repository.fetch(self.bound_branch.repository,
395
#### revision_id=revision_id)
398
"""Cleanup any open locks, progress bars etc."""
399
cleanups = [self._cleanup_bound_branch,
400
self.work_tree.unlock,
402
found_exception = None
403
for cleanup in cleanups:
406
# we want every cleanup to run no matter what.
407
# so we have a catchall here, but we will raise the
408
# last encountered exception up the stack: and
409
# typically this will be useful enough.
412
if found_exception is not None:
413
# don't do a plan raise, because the last exception may have been
414
# trashed, e is our sure-to-work exception even though it loses the
415
# full traceback. XXX: RBC 20060421 perhaps we could check the
416
# exc_info and if its the same one do a plain raise otherwise
417
# 'raise e' as we do now.
420
def _cleanup_bound_branch(self):
421
"""Executed at the end of a try/finally to cleanup a bound branch.
423
If the branch wasn't bound, this is a no-op.
424
If it was, it resents self.branch to the local branch, instead
427
if not self.bound_branch:
429
if self.master_locked:
430
self.master_branch.unlock()
314
def _record_inventory(self):
315
"""Store the inventory for the new revision."""
316
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
317
self.inv_sha1 = sha_string(inv_text)
318
s = self.branch.repository.control_weaves
319
s.add_text('inventory', self.rev_id,
320
split_lines(inv_text), self.present_parents,
321
self.branch.get_transaction())
432
323
def _escape_commit_message(self):
433
324
"""Replace xml-incompatible control characters."""
434
# FIXME: RBC 20060419 this should be done by the revision
435
# serialiser not by commit. Then we can also add an unescaper
436
# in the deserializer and start roundtripping revision messages
437
# precisely. See repository_implementations/test_repository.py
439
325
# Python strings can include characters that can't be
440
326
# represented in well-formed XML; escape characters that
441
327
# aren't listed in the XML specification
474
360
mutter("commit will ghost revision %r", parent_id)
362
def _make_revision(self):
363
"""Record a new revision object for this commit."""
364
self.rev = Revision(timestamp=self.timestamp,
365
timezone=self.timezone,
366
committer=self.committer,
367
message=self.message,
368
inventory_sha1=self.inv_sha1,
369
revision_id=self.rev_id,
370
properties=self.revprops)
371
self.rev.parent_ids = self.parents
373
serializer_v5.write_revision(self.rev, rev_tmp)
375
if self.config.signature_needed():
376
plaintext = Testament(self.rev, self.new_inv).as_short_text()
377
self.branch.repository.store_revision_signature(
378
gpg.GPGStrategy(self.config), plaintext, self.rev_id)
379
self.branch.repository.revision_store.add(rev_tmp, self.rev_id)
380
mutter('new revision_id is {%s}', self.rev_id)
476
382
def _remove_deleted(self):
477
383
"""Remove deleted files from the working inventories.
498
404
del self.work_inv[file_id]
499
405
self.work_tree._write_inventory(self.work_inv)
407
def _store_snapshot(self):
408
"""Pass over inventory and record a snapshot.
410
Entries get a new revision when they are modified in
411
any way, which includes a merge with a new set of
412
parents that have the same entry.
414
# XXX: Need to think more here about when the user has
415
# made a specific decision on a particular value -- c.f.
417
for path, ie in self.new_inv.iter_entries():
418
previous_entries = ie.find_previous_heads(
420
self.weave_store.get_weave_prelude_or_empty(ie.file_id,
421
self.branch.get_transaction()))
422
if ie.revision is None:
423
change = ie.snapshot(self.rev_id, path, previous_entries,
424
self.work_tree, self.weave_store,
425
self.branch.get_transaction())
428
self.reporter.snapshot_change(change, path)
501
430
def _populate_new_inv(self):
502
431
"""Build revision inventory.
509
438
revision set to their prior value.
511
440
mutter("Selecting files for commit with filter %s", self.specific_files)
512
# iter_entries does not visit the ROOT_ID node so we need to call
513
# self._emit_progress_update once by hand.
514
self._emit_progress_update()
441
self.new_inv = Inventory()
515
442
for path, new_ie in self.work_inv.iter_entries():
516
self._emit_progress_update()
517
443
file_id = new_ie.file_id
518
mutter('check %s {%s}', path, file_id)
519
if (not self.specific_files or
520
is_inside_or_parent_of_any(self.specific_files, path)):
521
mutter('%s selected for commit', path)
525
mutter('%s not selected for commit', path)
526
if self.basis_inv.has_id(file_id):
527
ie = self.basis_inv[file_id].copy()
529
# this entry is new and not being committed
444
mutter('check %s {%s}', path, new_ie.file_id)
445
if self.specific_files:
446
if not is_inside_any(self.specific_files, path):
447
mutter('%s not selected for commit', path)
448
self._carry_entry(file_id)
532
self.builder.record_entry_contents(ie, self.parent_invs,
533
path, self.work_tree)
534
# describe the nature of the change that has occurred relative to
535
# the basis inventory.
536
if (self.basis_inv.has_id(ie.file_id)):
537
basis_ie = self.basis_inv[ie.file_id]
540
change = ie.describe_change(basis_ie, ie)
541
if change in (InventoryEntry.RENAMED,
542
InventoryEntry.MODIFIED_AND_RENAMED):
543
old_path = self.basis_inv.id2path(ie.file_id)
544
self.reporter.renamed(change, old_path, path)
546
self.reporter.snapshot_change(change, 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)
451
# this is selected, ensure its parents are too.
452
parent_id = new_ie.parent_id
453
while parent_id != ROOT_ID:
454
if not self.new_inv.has_id(parent_id):
455
ie = self._select_entry(self.work_inv[parent_id])
456
mutter('%s selected for commit because of %s',
457
self.new_inv.id2path(parent_id), path)
459
ie = self.new_inv[parent_id]
460
if ie.revision is not None:
462
mutter('%s selected for commit because of %s',
463
self.new_inv.id2path(parent_id), path)
464
parent_id = ie.parent_id
465
mutter('%s selected for commit', path)
466
self._select_entry(new_ie)
468
def _select_entry(self, new_ie):
469
"""Make new_ie be considered for committing."""
475
def _carry_entry(self, file_id):
476
"""Carry the file unchanged from the basis revision."""
477
if self.basis_inv.has_id(file_id):
478
self.new_inv.add(self.basis_inv[file_id].copy())
553
480
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)
481
for file_id in self.basis_inv:
482
if file_id not in self.new_inv:
483
self.reporter.deleted(self.basis_inv.id2path(file_id))
485
def _gen_revision_id(config, when):
486
"""Return new revision-id."""
487
s = '%s-%s-' % (config.user_email(), compact_date(when))
488
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
