76
76
from bzrlib.osutils import (local_time_offset,
77
77
rand_bytes, compact_date,
78
78
kind_marker, is_inside_any, quotefn,
79
sha_file, isdir, isfile,
79
sha_string, sha_strings, sha_file, isdir, isfile,
81
81
import bzrlib.config
82
import bzrlib.errors as errors
83
82
from bzrlib.errors import (BzrError, PointlessCommit,
87
import bzrlib.gpg as gpg
88
88
from bzrlib.revision import Revision
89
89
from bzrlib.testament import Testament
90
90
from bzrlib.trace import mutter, note, warning
91
91
from bzrlib.xml5 import serializer_v5
92
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
92
from bzrlib.inventory import Inventory, ROOT_ID
93
93
from bzrlib.symbol_versioning import *
94
from bzrlib.weave import Weave
95
from bzrlib.weavefile import read_weave, write_weave_v5
94
96
from bzrlib.workingtree import WorkingTree
124
126
def missing(self, path):
127
def renamed(self, change, old_path, new_path):
131
130
class ReportCommitToLog(NullCommitReporter):
133
# this may be more useful if 'note' was replaced by an overridable
134
# method on self, which would allow more trivial subclassing.
135
# alternative, a callable could be passed in, allowing really trivial
136
# reuse for some uis. RBC 20060511
138
132
def snapshot_change(self, change, path):
139
if change == 'unchanged':
141
133
note("%s %s", change, path)
143
135
def completed(self, revno, rev_id):
144
note('Committed revision %d.', revno)
136
note('committed r%d {%s}', revno, rev_id)
146
138
def deleted(self, file_id):
147
139
note('deleted %s', file_id)
239
224
raise BzrError("The message keyword parameter is required for commit().")
241
226
self.weave_store = self.branch.repository.weave_store
242
self.bound_branch = None
244
self.master_branch = None
245
self.master_locked = False
246
227
self.rev_id = rev_id
247
228
self.specific_files = specific_files
248
229
self.allow_pointless = allow_pointless
250
if revprops is not None:
230
self.revprops = {'branch-nick': self.branch.nick}
251
232
self.revprops.update(revprops)
253
if reporter is None and self.reporter is None:
254
self.reporter = NullCommitReporter()
255
elif reporter is not None:
256
self.reporter = reporter
258
self.work_tree.lock_write()
259
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
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()
261
# Cannot commit with conflicts present.
262
if len(self.work_tree.conflicts())>0:
263
raise ConflictsInTree
265
# setup the bound branch variables as needed.
266
self._check_bound_branch()
268
# check for out of date working trees
269
# if we are bound, then self.branch is the master branch and this
270
# test is thus all we need.
271
if self.work_tree.last_revision() != self.master_branch.last_revision():
272
raise errors.OutOfDateTree(self.work_tree)
275
# raise an exception as soon as we find a single unknown.
276
for unknown in self.work_tree.unknowns():
277
raise StrictCommitFailed()
279
if timestamp is None:
280
self.timestamp = time.time()
282
self.timestamp = long(timestamp)
284
if self.config is None:
285
self.config = bzrlib.config.BranchConfig(self.branch)
288
self.rev_id = _gen_revision_id(self.config, self.timestamp)
292
if committer is None:
293
self.committer = self.config.username()
295
assert isinstance(committer, basestring), type(committer)
296
self.committer = committer
299
self.timezone = local_time_offset()
301
self.timezone = int(timezone)
303
if isinstance(message, str):
304
message = message.decode(bzrlib.user_encoding)
305
assert isinstance(message, unicode), type(message)
306
self.message = message
307
self._escape_commit_message()
309
271
self.work_inv = self.work_tree.inventory
310
self.basis_tree = self.work_tree.basis_tree()
272
self.basis_tree = self.branch.basis_tree()
311
273
self.basis_inv = self.basis_tree.inventory
312
# one to finish, one for rev and inventory, and one for each
313
# inventory entry, and the same for the new inventory.
314
# note that this estimate is too long when we do a partial tree
315
# commit which excludes some new files from being considered.
316
# The estimate is corrected when we populate the new inv.
317
self.pb_total = len(self.basis_inv) + len(self.work_inv) + 3 - 1
320
275
self._gather_parents()
321
276
if len(self.parents) > 1 and self.specific_files:
322
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')
324
278
self._check_parents_present()
326
280
self._remove_deleted()
333
287
or self.new_inv != self.basis_inv):
334
288
raise PointlessCommit()
336
self._emit_progress_update()
337
self.inv_sha1 = self.branch.repository.add_inventory(
342
self._emit_progress_update()
290
if len(list(self.work_tree.iter_conflicts()))>0:
291
raise ConflictsInTree
293
self._record_inventory()
343
294
self._make_revision()
344
# revision data is in the local branch now.
346
# upload revision data to the master.
347
# this will propogate merged revisions too if needed.
348
if self.bound_branch:
349
self.master_branch.repository.fetch(self.branch.repository,
350
revision_id=self.rev_id)
351
# now the master has the revision data
352
# 'commit' to the master first so a timeout here causes the local
353
# branch to be out of date
354
self.master_branch.append_revision(self.rev_id)
356
# and now do the commit locally.
295
self.work_tree.set_pending_merges([])
357
296
self.branch.append_revision(self.rev_id)
359
self.work_tree.set_pending_merges([])
360
self.work_tree.set_last_revision(self.rev_id)
361
# now the work tree is up to date with the branch
363
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)
364
303
if self.config.post_commit() is not None:
365
304
hooks = self.config.post_commit().split(' ')
366
305
# this would be nicer with twisted.python.reflect.namedAny
369
308
{'branch':self.branch,
371
310
'rev_id':self.rev_id})
372
self._emit_progress_update()
376
def _check_bound_branch(self):
377
"""Check to see if the local branch is bound.
379
If it is bound, then most of the commit will actually be
380
done using the remote branch as the target branch.
381
Only at the end will the local branch be updated.
383
if self.local and not self.branch.get_bound_location():
384
raise errors.LocalRequiresBoundBranch()
387
self.master_branch = self.branch.get_master_branch()
389
if not self.master_branch:
390
# make this branch the reference branch for out of date checks.
391
self.master_branch = self.branch
394
# If the master branch is bound, we must fail
395
master_bound_location = self.master_branch.get_bound_location()
396
if master_bound_location:
397
raise errors.CommitToDoubleBoundBranch(self.branch,
398
self.master_branch, master_bound_location)
400
# TODO: jam 20051230 We could automatically push local
401
# commits to the remote branch if they would fit.
402
# But for now, just require remote to be identical
405
# Make sure the local branch is identical to the master
406
master_rh = self.master_branch.revision_history()
407
local_rh = self.branch.revision_history()
408
if local_rh != master_rh:
409
raise errors.BoundBranchOutOfDate(self.branch,
412
# Now things are ready to change the master branch
414
self.bound_branch = self.branch
415
self.master_branch.lock_write()
416
self.master_locked = True
418
#### # Check to see if we have any pending merges. If we do
419
#### # those need to be pushed into the master branch
420
#### pending_merges = self.work_tree.pending_merges()
421
#### if pending_merges:
422
#### for revision_id in pending_merges:
423
#### self.master_branch.repository.fetch(self.bound_branch.repository,
424
#### revision_id=revision_id)
427
"""Cleanup any open locks, progress bars etc."""
428
cleanups = [self._cleanup_bound_branch,
429
self.work_tree.unlock,
431
found_exception = None
432
for cleanup in cleanups:
435
# we want every cleanup to run no matter what.
436
# so we have a catchall here, but we will raise the
437
# last encountered exception up the stack: and
438
# typically this will be useful enough.
441
if found_exception is not None:
442
# dont do a plan raise, because the last exception may have been
443
# trashed, e is our sure-to-work exception even though it loses the
444
# full traceback. XXX: RBC 20060421 perhaps we could check the
445
# exc_info and if its the same one do a plain raise otherwise
446
# 'raise e' as we do now.
449
def _cleanup_bound_branch(self):
450
"""Executed at the end of a try/finally to cleanup a bound branch.
452
If the branch wasn't bound, this is a no-op.
453
If it was, it resents self.branch to the local branch, instead
456
if not self.bound_branch:
458
if self.master_locked:
459
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())
461
323
def _escape_commit_message(self):
462
324
"""Replace xml-incompatible control characters."""
463
# FIXME: RBC 20060419 this should be done by the revision
464
# serialiser not by commit. Then we can also add an unescaper
465
# in the deserializer and start roundtripping revision messages
466
# precisely. See repository_implementations/test_repository.py
468
325
# Python strings can include characters that can't be
469
326
# represented in well-formed XML; escape characters that
470
327
# aren't listed in the XML specification
505
362
def _make_revision(self):
506
363
"""Record a new revision object for this commit."""
507
rev = Revision(timestamp=self.timestamp,
508
timezone=self.timezone,
509
committer=self.committer,
510
message=self.message,
511
inventory_sha1=self.inv_sha1,
512
revision_id=self.rev_id,
513
properties=self.revprops)
514
rev.parent_ids = self.parents
515
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
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)
517
382
def _remove_deleted(self):
518
383
"""Remove deleted files from the working inventories.
549
414
# XXX: Need to think more here about when the user has
550
415
# made a specific decision on a particular value -- c.f.
553
# iter_entries does not visit the ROOT_ID node so we need to call
554
# self._emit_progress_update once by hand.
555
self._emit_progress_update()
556
417
for path, ie in self.new_inv.iter_entries():
557
self._emit_progress_update()
558
418
previous_entries = ie.find_previous_heads(
561
self.branch.repository.get_transaction())
420
self.weave_store.get_weave_prelude_or_empty(ie.file_id,
421
self.branch.get_transaction()))
562
422
if ie.revision is None:
563
# we are creating a new revision for ie in the history store
565
ie.snapshot(self.rev_id, path, previous_entries,
566
self.work_tree, self.weave_store,
567
self.branch.repository.get_transaction())
568
# describe the nature of the change that has occured relative to
569
# the basis inventory.
570
if (self.basis_inv.has_id(ie.file_id)):
571
basis_ie = self.basis_inv[ie.file_id]
574
change = ie.describe_change(basis_ie, ie)
575
if change in (InventoryEntry.RENAMED,
576
InventoryEntry.MODIFIED_AND_RENAMED):
577
old_path = self.basis_inv.id2path(ie.file_id)
578
self.reporter.renamed(change, old_path, path)
580
self.reporter.snapshot_change(change, path)
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)
582
430
def _populate_new_inv(self):
583
431
"""Build revision inventory.
637
476
"""Carry the file unchanged from the basis revision."""
638
477
if self.basis_inv.has_id(file_id):
639
478
self.new_inv.add(self.basis_inv[file_id].copy())
641
# this entry is new and not being committed
644
480
def _report_deletes(self):
645
for path, ie in self.basis_inv.iter_entries():
646
if ie.file_id not in self.new_inv:
647
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))
649
485
def _gen_revision_id(config, when):
650
486
"""Return new revision-id."""
added
removed
bzrlib/commit.py
