72
from binascii import hexlify
72
73
from cStringIO import StringIO
74
from bzrlib.atomicfile import AtomicFile
75
from bzrlib.osutils import (local_time_offset,
76
rand_bytes, compact_date,
77
kind_marker, is_inside_any, quotefn,
78
sha_string, sha_strings, sha_file, isdir, isfile,
80
from bzrlib.branch import gen_file_id
75
81
import bzrlib.config
76
import bzrlib.errors as errors
77
82
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)
87
import bzrlib.gpg as gpg
88
from bzrlib.revision import Revision
84
89
from bzrlib.testament import Testament
85
90
from bzrlib.trace import mutter, note, warning
86
91
from bzrlib.xml5 import serializer_v5
87
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
88
from bzrlib.symbol_versioning import (deprecated_passed,
92
from bzrlib.workingtree import WorkingTree
95
@deprecated_function(zero_seven)
92
from bzrlib.inventory import Inventory, ROOT_ID
93
from bzrlib.weave import Weave
94
from bzrlib.weavefile import read_weave, write_weave_v5
95
from bzrlib.atomicfile import AtomicFile
96
98
def commit(*args, **kwargs):
97
99
"""Commit a new revision to a branch.
122
124
def missing(self, path):
125
def renamed(self, change, old_path, new_path):
129
127
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
129
def snapshot_change(self, change, path):
137
if change == 'unchanged':
139
130
note("%s %s", change, path)
141
132
def completed(self, revno, rev_id):
142
note('Committed revision %d.', revno)
133
note('committed r%d {%s}', revno, rev_id)
144
135
def deleted(self, file_id):
145
136
note('deleted %s', file_id)
218
196
contains unknown files.
220
198
revprops -- Properties for new revision
221
:param local: Perform a local only commit.
223
200
mutter('preparing to commit')
225
if deprecated_passed(branch):
226
warnings.warn("Commit.commit (branch, ...): The branch parameter is "
227
"deprecated as of bzr 0.8. Please use working_tree= instead.",
228
DeprecationWarning, stacklevel=2)
230
self.work_tree = self.branch.bzrdir.open_workingtree()
231
elif working_tree is None:
232
raise BzrError("One of branch and working_tree must be passed into commit().")
234
self.work_tree = working_tree
235
self.branch = self.work_tree.branch
237
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
203
self.weave_store = branch.weave_store
244
205
self.specific_files = specific_files
245
206
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()
207
self.revprops = revprops
210
# raise an exception as soon as we find a single unknown.
211
for unknown in branch.unknowns():
212
raise StrictCommitFailed()
214
if timestamp is None:
215
self.timestamp = time.time()
217
self.timestamp = long(timestamp)
219
if self.config is None:
220
self.config = bzrlib.config.BranchConfig(self.branch)
223
self.rev_id = _gen_revision_id(self.config, self.timestamp)
227
if committer is None:
228
self.committer = self.config.username()
230
assert isinstance(committer, basestring), type(committer)
231
self.committer = committer
234
self.timezone = local_time_offset()
236
self.timezone = int(timezone)
238
assert isinstance(message, basestring), type(message)
239
self.message = message
240
self._escape_commit_message()
242
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()
244
self.work_tree = self.branch.working_tree()
282
245
self.work_inv = self.work_tree.inventory
283
self.basis_tree = self.work_tree.basis_tree()
246
self.basis_tree = self.branch.basis_tree()
284
247
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
249
self._gather_parents()
294
250
if len(self.parents) > 1 and self.specific_files:
295
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
251
raise NotImplementedError('selected-file commit of merges is not supported yet')
297
252
self._check_parents_present()
298
self.builder = self.branch.get_commit_builder(self.parents,
299
self.config, timestamp, timezone, committer, revprops, rev_id)
301
254
self._remove_deleted()
302
255
self._populate_new_inv()
256
self._store_snapshot()
303
257
self._report_deletes()
305
259
if not (self.allow_pointless
306
260
or len(self.parents) > 1
307
or self.builder.new_inventory != self.basis_inv):
261
or self.new_inv != self.basis_inv):
308
262
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)
264
if len(list(self.work_tree.iter_conflicts()))>0:
265
raise ConflictsInTree
329
# and now do the commit locally.
267
self._record_inventory()
268
self._make_revision()
330
269
self.branch.append_revision(self.rev_id)
332
270
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)
271
self.reporter.completed(self.branch.revno()+1, self.rev_id)
337
272
if self.config.post_commit() is not None:
338
273
hooks = self.config.post_commit().split(' ')
339
274
# this would be nicer with twisted.python.reflect.namedAny
342
277
{'branch':self.branch,
344
279
'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()
283
def _record_inventory(self):
284
"""Store the inventory for the new revision."""
285
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
286
self.inv_sha1 = sha_string(inv_text)
287
s = self.branch.control_weaves
288
s.add_text('inventory', self.rev_id,
289
split_lines(inv_text), self.present_parents,
290
self.branch.get_transaction())
427
292
def _escape_commit_message(self):
428
293
"""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
294
# Python strings can include characters that can't be
435
295
# represented in well-formed XML; escape characters that
436
296
# aren't listed in the XML specification
437
297
# (http://www.w3.org/TR/REC-xml/#NT-Char).
298
if isinstance(self.message, unicode):
299
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
301
# Use a regular 'str' as pattern to avoid having re.subn
302
# return 'unicode' results.
303
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
438
304
self.message, escape_count = re.subn(
439
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
440
306
lambda match: match.group(0).encode('unicode_escape'),
445
311
def _gather_parents(self):
446
312
"""Record the parents of a merge for merge detection."""
447
# TODO: Make sure that this list doesn't contain duplicate
448
# entries and the order is preserved when doing this.
449
self.parents = self.work_tree.get_parent_ids()
313
pending_merges = self.work_tree.pending_merges()
450
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
451
321
for revision in self.parents:
452
if self.branch.repository.has_revision(revision):
453
inventory = self.branch.repository.get_inventory(revision)
454
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)
456
326
def _check_parents_present(self):
457
327
for parent_id in self.parents:
458
328
mutter('commit parent revision {%s}', parent_id)
459
if not self.branch.repository.has_revision(parent_id):
329
if not self.branch.has_revision(parent_id):
460
330
if parent_id == self.branch.last_revision():
461
331
warning("parent is missing %r", parent_id)
462
raise BzrCheckError("branch %s is missing revision {%s}"
463
% (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)
465
356
def _remove_deleted(self):
466
357
"""Remove deleted files from the working inventories.
487
378
del self.work_inv[file_id]
488
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_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)
490
404
def _populate_new_inv(self):
491
405
"""Build revision inventory.
498
412
revision set to their prior value.
500
414
mutter("Selecting files for commit with filter %s", self.specific_files)
501
# iter_entries does not visit the ROOT_ID node so we need to call
502
# self._emit_progress_update once by hand.
503
self._emit_progress_update()
415
self.new_inv = Inventory()
504
416
for path, new_ie in self.work_inv.iter_entries():
505
self._emit_progress_update()
506
417
file_id = new_ie.file_id
507
mutter('check %s {%s}', path, file_id)
508
if (not self.specific_files or
509
is_inside_or_parent_of_any(self.specific_files, path)):
510
mutter('%s selected for commit', path)
514
mutter('%s not selected for commit', path)
515
if self.basis_inv.has_id(file_id):
516
ie = self.basis_inv[file_id].copy()
518
# 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)
521
self.builder.record_entry_contents(ie, self.parent_invs,
522
path, self.work_tree)
523
# describe the nature of the change that has occurred relative to
524
# the basis inventory.
525
if (self.basis_inv.has_id(ie.file_id)):
526
basis_ie = self.basis_inv[ie.file_id]
529
change = ie.describe_change(basis_ie, ie)
530
if change in (InventoryEntry.RENAMED,
531
InventoryEntry.MODIFIED_AND_RENAMED):
532
old_path = self.basis_inv.id2path(ie.file_id)
533
self.reporter.renamed(change, old_path, path)
535
self.reporter.snapshot_change(change, path)
537
def _emit_progress_update(self):
538
"""Emit an update to the progress bar."""
539
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())
542
454
def _report_deletes(self):
543
for path, ie in self.basis_inv.iter_entries():
544
if ie.file_id not in self.builder.new_inventory:
545
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
