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